Mark stale docs at top-level with warning banner #25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ble search strings.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here's another horrifying (but orthogonal) script-generated commit, building upon 'cleanup.py' (-> 'cleanup.ipynb'). It deprecates any HTML in the following folders which doesn't appear in the (given, in this case '2.2.2') current release.
'Deprecation' means putting a sticky red banner in, with a suggested search string. Bots are not forwarded (via rel='canonical') because we don't know where the content went. Even if the page has obviously just been refiled (e.g. tight layout guide), we punt to the search engine to do the fuzzy match.
Stale .py or .pdf (but not .png, e.g. in _images) files found in top-level (unversioned) docs are removed. This does break outdated examples' 'Source code' links. (Also, we could check HTML title elements for the outdated version string.)
Edit: Oops, rerunning the script not only stacks 'unreleased-message' banners but is its main use case, fixing tomorrow. Will alias the style ('stale-docs-message') too.