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

Support documentation for historical releases on gh-pages branch? #570

Closed
edwardhartnett opened this issue Aug 18, 2021 · 2 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@edwardhartnett
Copy link
Collaborator

Currently we just have the documentation for the most recent release on the gh-pages branch.

But it has come up that some people may want to point to specific versions of the documentation. So what we can do is, on our gh-pages branch, put a top-level HTML page that lists the versions and links to their documentation, then, subdirectories for each version, with their documentation.

Then, as part of a new release, instead of completely overwriting the gh-pages branch, the process would be to just add a directory for the new version, and add a link to it at the top level.

@edwardhartnett edwardhartnett added the documentation Improvements or additions to documentation label Aug 18, 2021
@edwardhartnett edwardhartnett self-assigned this Aug 18, 2021
@GeorgeGayno-NOAA
Copy link
Collaborator

I will work this under #610.

@edwardhartnett
Copy link
Collaborator Author

OK, awesome. I already did this for one of the repos, I can't remember which.

Basically just create a directory for each release, and have the top-level page point to those subdirectories.

Then build the documentation as usual, but copy it to one of the subdirectories of the gh-pages branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants