Hello Beam folks,

I've received some good feedback that the Beam website can be difficult to
navigate, due to such things as:

- The top pulldown menus are too long and you can't select things at the
end, and this will only get worse as we create more pages
- The programming guide as a single page is too long and difficult to
navigate
- Navigation issues on mobile devices

In order to tackle these issues, we (myself and David Perez) have put
together a staged proposal [1] for an improved navigation story. It
includes:

- A new left nav that contains the lists of items previously in the top
pulldown. It's easy to change what items are displayed, you can nest
arbitrary items, etc. The left nav is scrollable on small windows, so you
can always reach everything. Users can now jump between programming guide
sections easily.
- On the right is a list of the sections within a page, so you can quickly
jump to where you want. The list is autogenerated from the sections in the
page.
- Mobile improvements such as: you can now get to the top nav items from
the home page.

This PR [2] would just be the first step. Once merged, it opens up other
improvements:

- Break apart the major sections of the programming guide into separate
pages. This allows for the addition of more details and code samples for
each section, without making an already-too-large page even larger. With
the left nav, jumping between these pages will be easy.
- A proper overview landing page for the SDKs section, that lists the
available SDKs, any differences, etc.
- Tweaking left nav items to bubble up previously hard-to-find content (for
example, the Python type safety and Python dependencies pages)

Please check it out and see what you think -- we'd love to get your
feedback.

Thanks!

[1] http://apache-beam-website-pull-requests.storage.
googleapis.com/332/index.html
[2] https://github.com/apache/beam-site/pull/332

Reply via email to