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

Utilize doc version switcher #106

Merged
merged 13 commits into from
Apr 18, 2023
Merged

Conversation

WardBrian
Copy link
Collaborator

This is something I've been thinking about since we merged #91 and #98 but haven't yet had a release: our online docs have updated to the latest API, but people who download/use it right now won't have that necessarily.

Obviously one fix is to always be prompt on releasing new code, but I think a better solution involves a more complete documentation site. Our theme supports version switchers, which we can use to keep multiple versions of the docs around.

This PR does a few things:

  1. The docs built on every push to main will now live at roualdes.github.io/bridgestan/latest/
  2. Each release will create a new sub-page, e.g. for version 2.0.1 there will be a copy at roualdes.github.io/bridgestan/v2.0.1/
  3. Our docs will have a nice version switcher to go between these different versions.

This will all be automated going forward, but the first time through I will need to make some manual changes to the gh-pages branch.

  1. We should add a redirect from roualdes.github.io/bridgestan/ to roualdes.github.io/bridgestan/latest/ (easy)
  2. It would be nice to go "back in time" and manually build a couple older versions of the docs with this enabled.

@WardBrian WardBrian added documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code labels Apr 18, 2023
@WardBrian WardBrian requested a review from roualdes April 18, 2023 14:53
Copy link
Owner

@roualdes roualdes left a comment

Choose a reason for hiding this comment

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

Great idea. The changes look good to me, in my novice github workflow opinion.

@WardBrian WardBrian merged commit bf91247 into roualdes:main Apr 18, 2023
@WardBrian WardBrian deleted the docs/version-number branch April 18, 2023 17:23
@WardBrian
Copy link
Collaborator Author

Updates should be live. https://roualdes.github.io/bridgestan will redirect to https://roualdes.github.io/bridgestan/latest, and the new drop down is visible in the top right

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 github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants