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

Add version support to docs site #830

Merged
merged 2 commits into from
May 23, 2022

Conversation

nguyer
Copy link
Contributor

@nguyer nguyer commented May 23, 2022

This PR adds significant new functionality to the docs GitHub action to manage versions of the docs site. This will create a directory tree that ends up looking like this:

+ / (latest release)
|-- v1.0.0
|-- v1.0.1
|-- ...
|-- head (current commit in main)

It will also build a JSON file that contains the full list of all these versions to build the dropdown menu that shows up in the docs rendered pages (with the addition of a latest link that links to /).

These changes allow us to always keep the docs up to date with the code in the same commit, but users navigating to the docs site will see the latest release by default. They can also use the dropdown menu to browse older release as well.

NOTE There will be a one time manual action necessary to generate docs for older versions. I can take care of this after this PR is approved and merged.

Signed-off-by: Nicko Guyer <nicko.guyer@kaleido.io>
@codecov-commenter
Copy link

codecov-commenter commented May 23, 2022

Codecov Report

Merging #830 (80bcd71) into main (0e4c169) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #830   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          299       299           
  Lines        19457     19457           
=========================================
  Hits         19457     19457           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0e4c169...80bcd71. Read the comment docs.

Copy link
Contributor

@peterbroadhurst peterbroadhurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved - as this looks sound, and I could follow the logic.
One item to review with regards to future maintainability.

Signed-off-by: Nicko Guyer <nicko.guyer@kaleido.io>
@peterbroadhurst peterbroadhurst merged commit a425fde into hyperledger:main May 23, 2022
@peterbroadhurst peterbroadhurst deleted the docs-versions branch May 23, 2022 21:38
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.

3 participants