snas / website Goto Github PK

Article with text, but also with a video.

Clean up the the readme to include the following:

• How to build locally to run tests
• Detail netlify integration
• Provide information about the process to contribute updates

Change contributing to be SNAS contributing, not the vector hugo template.

Looks like SNAS website was made out of KALDI website.

This image showed up when I linked from Slack chat.

Please replace with SNAS image.
https://github.com/SNAS/website/blob/master/site/layouts/partials/head.html#L34

On the About Ss page (http://www.snas.io/aboutus/), it says the following:

SNAS is a SNAS is a Linux Foundation Project licenced under Eclipse Public License v1.0

Please change this to:

SNAS is a project supported by The Linux Foundation's LF Networking Fund and has been established as Streaming Networks Analytics System a Series of LF Projects, LLC. For information on the project's governance, please review our charter which is located here [embed link to the charter, the same link that you use for the first item]. The project is licensed under Eclipse Public License v1.0.

Let's use same image on all pages.

We have 4 different docker packages (and installation instructions). These are listed at the end of the main install page. It'd be more user friendly to list these under "Docker Install" as sub-menu items.

http://localhost:3000/docs/requests/

Footer expands to cover most of the page. Restrict it to its original size when the text is small.

https://www.snas.io/docs/ is missing image
https://www.snas.io/demo/ is not in sync with the copy in github
Let's check in an hour or so if the issue persists. If it does, we need to find out why netlify's deployment looks different than our local deployments.

Analytics training showing how to trend advertisements overtime by bgp peer, originating ASN and transits.

They are in a narrow box centered in the page (e.g. http://localhost:3000/docs/architecture/) with lots of white space around. Can we expand the text to use more of the white space?

Add Use Cases section. This can be a default list of use-cases. We should start with some use-cases, such as:

1. Looking Glass
2. Monitoring BGP peers
3. Monitoring Prefixes and topology changes (this can include Unicast, EVPN, L3VPN, and Link-STate families
4. Simple Analytics

@Matvey-Kuk can you figure out if we can just click on the icons to see the content instead of needing to click on the button below? We can leave the buttons as well but it'd be really nice if the icons were clickable as well.

Hello everyone,

I have set up a test of SNAS on my server using the multi-container approach. I followed all the steps on the website, even copy/pasting the commands to run all docker containers.

However, while the router and the collector can communicate without problem, the collector seems to be unable to contact the kafka container. I am getting the following log entries on the collector container after a while :

2018-04-25T12:16:38.280170 | ERROR    | produce            | rtr=xx.xx.xx.xx: Failed to produce message: Local: Queue full
2018-04-25T12:16:38.380402 | ERROR    | send_bmp_raw       | rtr=xx.xx.xx.xx: Failed to produce bmp raw message: Local: Queue full

Again I did no specific configuration. I just ran the following commands in this order :

docker run -d --name=openbmp_mysql -e KAFKA_FQDN=localhost -e MEM=15 \
     -v /var/openbmp/mysql:/data/mysql -v /var/openbmp/config:/config \
     -p 3306:3306 -p 8001:8001 \
     openbmp/mysql

docker run -d \
     --name=openbmp_kafka \
     -e KAFKA_FQDN=localhost \
     -v /var/openbmp/kafka:/data/kafka \
     -p 2181:2181 -p 9092:9092 \
     openbmp/kafka

docker run -d --name=openbmp_collector -e KAFKA_FQDN=localhost \
     -v /var/openbmp/config:/config \
     -p 5000:5000 \
     openbmp/collector

All the directory structure is created as written on SNAS website.

I have checked the logs of all other containers and no one seems to complain about anything.
Thus I’m quite out of ideas to fix this issue.

Any help will be greatly appreciated.

Thanks in advance !

Ideally this should be arranged like other blog pages with the following:

• Categories for the type of blog (news, support, best practice, ...)
• There should be a side panel that highlights last/recent blogs
• Some type of "like" counter so people can vote if they like the blog
• Search capability

When i copied our docs from openbmp.org to snas.io, I didn't have enough time to make sure they are all formatted similarly. See http://localhost:3000/docs/use-case1/ vs http://localhost:3000/docs/architecture/. Can you go through all of them and make sure they have a similar format (I am working on the content).

Charter does not show up for the hamburger menu. It should be using the same data as the navbar.

Similar to what we see on http://www.grpc.io/

Article+video going over the schema and how to interact and customize it.

Currently developer schemas/specs are in two places, docs and on the main page under Developer integration. This should be reorganized so that they are in the same place, such as under developer section. The developer section should have:

1. API Documentation (e.g. Message Bus API, MariaDB Schema, and REST API). API documentation SHOULD contain examples as well, so each API might be a section by itself. For example, develop/api/msgbus, develop/api/topomgr, develop/api/db
2. Guides This section would include details of how a developer starts to develop and the options they have. Such as when to use live Kafka verses DB verses Topology Manager.
3. API Bindings - This is a summary page for bindings available. Links should reference the API documentation sections.

API documentation does not document the architecture or component itself. That's documented under component. Each API section should reference the component documentation for easy navigation between them.

We have several components that each have their own set of documents. I'm recommending we remove the docs section considering develop section will be added along with this new section to document each component.

Instead of using the default list for components, we should create a new list type 'components' for this section that supports organizing list items by category. We can then categorize the components so that it's easier to navigate. For example, Core, MRT, Data Handling (e.g. mysql consumer and the topology manager).

Please change the website footer to the following:

Copyright © 2018 Streaming Networks Analytics System a Series of LF Projects, LLC
For web site terms of use, trademark policy and general project policies please see https://lfprojects.org.

Article + video going over how to interact directly with Kafka message API's.

Lines 5-13 of index.html is very hard to read because each line is one giant long line. Is it possible to break them into multiple lines?

Currently the docs don't detail the steps to upgrade a container. The steps are pretty much the same for all containers. It would be nice to have a doc detailing the steps, maybe with examples.

I added a new favicon in openbmp-www/site/static/img/favicon.ico. All snas assets inlcuding pngs are now checked in. It'd be great to have the coffee favicon replaced.

Please upload the PDF/DOCX into the media section to create a PDF URL. Then in the main nav under Charter, replace the current web page with an embedded link that opens this PDF in another window. 

Clicking Docs-Getting Started-Docker Install shows us

• the "items" of the submenu
• content page of "Docs"
  It would be nice if it shows
• the "items" of the submenu
• its own content page
  I want to remove "Install Docker" as a submenu item and have the contents of it displayed when you click on "Docker Install" .

KAFKA_FQDN is being commonly misconfigured with a value that is either not resolvable or not accessible inside the container. This results in messages not being produced or consumed. This is a common mistake that hopefully can be addressed with better documentation.

Click: Docs-Getting Started-Docker Install-All-In-One, then,
Click "back button", takes you back to Home screen.
We want to go back to the position before the last click (Docs-Getting Started-Docker Install).
@TimEvens suggests we can use jQuery to control the back button.

When using the iPhone, the hamburger menu is truncated.

Align "SNAS, Home, About, Contact" horizontally. Anything else we should add here?

Write blog and tutorial about our demo-rv server (single server) scale to support route-views collections with over 120,000,000 active RIB entries (461 peers) with a constant rate of 2500+ NLRI's per second change/update rate. That's over 200,000,000 NLRI change (updates/withdraws) per day.

We need the ability to provide links to people to specific documents. A direct link to a document right now will result in the page not loading the sidebar or rendering the markdown correctly.

A direct link to a page should load the side bar and select/open the correct navigation item.

I copied some of the files from here:

https://github.com/OpenBMP/openbmp/tree/master/docs

to here:

https://www.snas.io/docs/

Can you check if I left out anything? For now all openbmp.org docs go here. And per previous issue I opened, they need to be formatted smilarly (I think all you need to do is add the title, type, and data on top and the "read more" line.