Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BEAM-12368] Updated doc nav to match wireframe #15229

Merged
merged 2 commits into from Jul 27, 2021
Merged

[BEAM-12368] Updated doc nav to match wireframe #15229

merged 2 commits into from Jul 27, 2021

Conversation

pcoet
Copy link
Collaborator

@pcoet pcoet commented Jul 27, 2021

This PR changes the left nav to more closely match the wireframe. There are still some rough edges in the user experience, but it's better than the current nav, where the "Beam programming guide" node is not collapsible.

@aaltay
@tysonjh

NOTE: The diff is hard to read, with all of the HTML copy-paste. It's easier to just look at the staged site and compare it to the prod site, to see what's changed. All of the individual pages should still be findable in the nav.

Please add a meaningful description for your change here


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Choose reviewer(s) and mention them in a comment (R: @username).
  • Format the pull request title like [BEAM-XXX] Fixes bug in ApproximateQuantiles, where you replace BEAM-XXX with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

ValidatesRunner compliance status (on master branch)

Lang ULR Dataflow Flink Samza Spark Twister2
Go --- Build Status Build Status Build Status Build Status ---
Java Build Status Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Build Status
Python --- Build Status
Build Status
Build Status
Build Status
Build Status
Build Status Build Status ---
XLang Build Status Build Status Build Status Build Status Build Status ---

Examples testing status on various runners

Lang ULR Dataflow Flink Samza Spark Twister2
Go --- --- --- --- --- --- ---
Java --- Build Status
Build Status
Build Status
--- --- --- --- ---
Python --- --- --- --- --- --- ---
XLang --- --- --- --- --- --- ---

Post-Commit SDK/Transform Integration Tests Status (on master branch)

Go Java Python
Build Status Build Status Build Status
Build Status
Build Status

Pre-Commit Tests Status (on master branch)

--- Java Python Go Website Whitespace Typescript
Non-portable Build Status
Build Status
Build Status
Build Status
Build Status
Build Status Build Status Build Status Build Status
Portable --- Build Status Build Status --- --- ---

See .test-infra/jenkins/README for trigger phrase, status and link of all Jenkins jobs.

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests

See CI.md for more information about GitHub Actions CI.

@aaltay
Copy link
Member

aaltay commented Jul 27, 2021

Looks great. Should we alphabetically sort the left nav? Or perhaps go in some logical order like starting from concepts etc. before going into details?

@pcoet
Copy link
Collaborator Author

pcoet commented Jul 27, 2021

Yup, I agree that the first ordering wasn't great. Alphabetical order is more useful when users already know what they're looking for -- I think we're better off with a logical order, which to me means a learning path. I reordered with what seems natural to me -- start with concepts and programming guide, and end with reference material and glossary. What do you think?

@aaltay
Copy link
Member

aaltay commented Jul 27, 2021

Yup, I agree that the first ordering wasn't great. Alphabetical order is more useful when users already know what they're looking for -- I think we're better off with a logical order, which to me means a learning path. I reordered with what seems natural to me -- start with concepts and programming guide, and end with reference material and glossary. What do you think?

Great, thank you.

I was wondering if "Pipeline development lifecycle" would be better before programming guide, but I do not have a strong opinion. Let's go wit this version.

@aaltay aaltay merged commit e4abe0d into apache:master Jul 27, 2021
ryanthompson591 pushed a commit to ryanthompson591/beam that referenced this pull request Aug 10, 2021
calvinleungyk pushed a commit to calvinleungyk/beam that referenced this pull request Sep 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants