fdio / site Goto Github PK

On the project page here...under CSIT...

https://deploy-preview-15--fdio.netlify.com/projects/

"...perforance and functionality..." should be "performance and functionality..."

"Easily programable" should be "Easily programmable" here:

https://deploy-preview-15--fdio.netlify.com

1. The main documentation page is ugly. https://fd.io/documentation/ It's difficult to find the VPP documentation.
2. Where to store documentation? Is it fine to keep it on github? Currently half of the documentation is in VPP repo and some parts on github, and the developer documentation is on nexus.
3. Pointer from documentation to featurelist. Ensure feature list is marked with generation date / version
4. Automatically update documentation for master per patch
5. Automate documentation for release. Currently requires manually updating config.toml, content/documentation/vpp.md, content/vppProject/vppbuilding/vpp.md and vpp/docs/conf.py
6. A google returns lots of very old links, back to 17.04.
7. What about vpp.readthedocs.io?

Hi Ed,

I will need additional time to due this review justice. Specifically we need to update the message to support the scalability and feature richness. Right now only fast and it's "time" analogy is in place.

A few additional suggested edits from quick review:
Right at the top, change FD.IO to FD.io to reflect project name.
Change in dialog box to get to the projects to "FD.io projects" as "The" is not necessary.
Logo looks faded. Chase down high resolution one from Jill.
Not comfortable with "The future of packet processing. Now." What about "The future of packet processing is here!"

@nealtex01 has kindly commissioned some mock ups of a visual rework of the FD.io website:

https://docs.google.com/presentation/d/1928l56YGFk9oBuWaAx0FRzZBUUnGnIJDOxb1qMzaj-c/edit#slide=id.g100f35f23ab_2_0

@otroan @sknat Thoughts?

created from #99 to keep one-issue-per-issue, in order to make the discussion/tracking easier.

2. Where to store documentation? Is it fine to keep it on github? Currently half of the documentation is in VPP repo and some parts on github, and the developer documentation is on nexus.

A little tuning to the website navigation structure can help users find their way around our site and (existing) content a little more easily. The proposed changes should be straightforward to implement, and IMHO will bring the site nav to a more intuitive experience - one where a greenfield visitor is walked left to right as people (at least in western cultures) tend to think:

1. What is this thing?
2. What technology makes it go?
3. What features are made possible by the tech?
4. What applications are made possible by the features?
5. What actual solutions exist?
6. OK, cool. I'm sold. Now take me deeper.
7. I want to keep up, What's the latest news?
8. Who's behind this thing anyway? And what if I want to join?

To get there, these changes are recommended:

1. Main Nav 1 item shop due "What is FD.IO?". Create a new page and take the copy from the Get Involved page and put it here.
2. Main Nav 2 is the current "Get Started With VPP" page as is, but should be renamed as "Technology". Technology should be a single page, no sub nav. Simply use the existing Technology page content as it is.
3. Main Nav 3 should be the existing Features page - which is current sub nav item under "Get Started with VPP".
4. Main Nav 4 should be the current "Use Cases" page as is, but renamed as "Applications". By way of explanation, the actual listings are secure networking application highlights. Use cases more typically stories about a customer implementation of a given application.
5. Main Nav 5 should be the current "Customer Solutions" page, but renamed as "Solutions". The latter is exactly what is shown. Each vendor implementation should have a URL link to a page (Landing/Web) page of the vendor's choice -and one designed to cross promote the importance / presence of VPP.
6. "Customer Feedback" should be "Customer Quotes" and should be moved under "Customer Solutions" as a sub nav. This section has only 'vendor' quotes at present, but that is a separate matter. I'll take this opportunity to explain that, IMHO, we want the site to take on more of "end customer" feel, and less of a "vendor customer" feel. It has been agreed (in the FD.io MAC, at least) that VPP is well-established and accepted amongst secure networking vendors. That goal is largely achieved, as I understand. The challenge now is to get broader "end user" awareness, acceptance, and pull through for products that have "VPP within". I often draw a parallel to Intel's legendary branding campaign, "Intel Inside". We want end users to 'demand' that their products have 'VPP inside'. VPP is way down the stack, so it is harder to make into a headline story. The best way to do this is show end-user 'birds of feather' quotes, hence "Customer Quotes" stated by true end users, as opposed to vendor "technology fraternity". This is the key thrust of 2021 for the MAC - drive more end user (and by extension vendor) stories.
7. Main Nav 6 should be "Resources" and should have the following sub nav: "White Papers"(currently under "Use Cases"), "Project Documentation", "Installing", "Building" intuit order left to right. Each page currently exists, use as is for now.
8. Main Nav 7 should be "The Latest" page renamed to "News". Sub menu distinctions "News" and "Archive" should go away. Just have a single rolling list by date stamp. That removes the work of having to draw some arbitrary line and move assets on some interval basis - which is needless work.
9. Main Nav 8 should be the "Get Involved" page but renamed "About". "About" sub nav items should be "TSC", "Key Documents" (renamed from TSC Documents), and "Join Project" - in that order left to right.

Currently, there is basic RSS feed support enabled so a latest news feed exists:
https://fd.io/latest/news/index.xml

However, viewing an article such as "Myth-busting DPDK in 2020" presents a link to
https://fd.io/latest/news/dpdk2020/ which is.. practically useless.

The link should be the same as what the "read more" button points to.
In this case: https://nextgeninfra.io/dpdk-myth-busting-2020/

This page describes the socketsvr parameter which actually doesn't exist. The proper name for it is socksvr.

@nealtex01 suggested the attached text change to the front page, thoughts?

fd.io home page messaging.pdf

Description

All of the slack links present in fd.io/community reject email outside of fd.io org. I tried to sign in via my Gmail account, & it simply returns a log stating that email doesn’t have an account on this workspace. I even went with manual sign-up option where it sends a magic-link for sign-up, but then it returns "no account found" with this message 👇🏼

Please resolve this issue asap 🙏🏼

The sphinx build must have something broken as some links point to a different release instead of the current one.

For instance:

https://s3-docs.fd.io/vpp/22.06/gettingstarted/progressivevpp/interface.html

Links point to non existant pages related to 17.04 or 21.06.

What's there looks good guys.

What about the "Announcements" section we have in current portal - will that be moved later?

Collecting public references of VPP use cases to be added to fd.io web site

From PR#139:

• Submitted by JDiGiglio

  Here are few public references to consumption of VPP:
  Samsung 5G UPF stack built on top of VPP: https://networkbuilders.intel.com/solutionslibrary/samsung-achieves-305-gbps-on-5g-upf-core-utilizing-intel-architecture. From the paper: Samsung utilizes DPDK (Data Plane Development Kit)/VPP
  (Vector Packet Processing) technologies.

  Another one that we already have a solution guide is Yahoo JAPAN: https://lfnetworking.lfprojects.linuxfoundation.org/fd-io/2019/08/13/yahoo-japan-solutions-brief/

• Submitted by muscariello:

  https://docs.equinix.com/en-us/Content/Interconnection/NE/deploy-guide/NE-platform-architecture.htm

We have moved the documentation landing page to https://hicn.readthedocs.io/en/latest/
which is automatically built by the readthedocs platform.

The platforms builds docs from all tags found in https://github.com/FDio/hicn
starting from tag 22.02 e.g. https://hicn.readthedocs.io/en/v22.02-rc0/