-
Notifications
You must be signed in to change notification settings - Fork 15
Add outdated version warning #185
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
Conversation
WebReflection
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
|
Thanks @WebReflection for reviewing. I don't have write access to this repo, so you'll have to merge it as well. |
|
In order to update all previous versions: Then |
|
@danyeaw is this something we need to do manually and/or ASAP or just a reminder for the next time we release? |
|
Sorry, context is that although this PR updates versions going forward with this logic to show the old version warning. It doesn't update versions that were already released. After sleeping on it, I don't think that script will work. It will update the previous versions, but will rebuild them all with the content in the current version. I'll keep thinking about this. |
|
Hi @danyeaw - I'm finally getting to this PR (stacked on other docs related work I'm currently doing). I see the changes in #187 - please can you confirm how you did this? I assume some variation of the I also notice that I think, given the amount of time since this work was done, I should create a new (stacked-on-current-work) PR and redo these changes for all the versions up to this point in time. Furthermore, I'll confirm such updating of a docs version will work moving forward. I have a sneaky feeling our docs are hosted on S3 so we'll need to (re) copy all the files into the right bucket. |
|
Hey @ntoll - ya I think I created a script to go through and update them all. Since we have the version warning on all the versions since the summer already, we shouldn't need to add any additional changes. If you want to try to redo the changes that's ok. I can also rebase the changes or push other updates if needed. |
As suggested by @kattni (ty!) during a community call, it is currently easy for users to find a version of our docs that aren't the latest version. This PR adds an outdated mkdocs extension to show a warning with a link to view the latest version. I was trying to go for clear but slightly playful on the message - open to different wording as well.
I tested this locally with: