Add legacy docs deprecation warning on every page #860
+5
−0
Conversation
This file contains 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
6 tasks
dkliban
reviewed
May 2, 2024
templates/docs/docs/conf.py.j2
Outdated
| @@ -317,3 +317,8 @@ class MyPythonDomain(PythonDomain): | |||
| def setup(sphinx): | |||
| """Use MyPythonDomain in place of PythonDomain""" | |||
| sphinx.add_domain(MyPythonDomain, override=True) | |||
|
|
|||
| rst_prolog = """.. attention:: | |||
| This docs will be deactivated in July 2024. `Learn More <https://discourse.pulpproject.org/t/unified-documentation-part-2/1188>`_ | |||
There was a problem hiding this comment.
Let's just say "This documentation will be deactivated in the near future." so we don't have to do anything on a specific date.
There was a problem hiding this comment.
Yep. Never write docs that plan to be outdated.
The old docs should be deactivated on July 2024. [noissue]
pedro-psb
force-pushed
the
add-deprecation-notice
branch
from
f8267c6
to
a789dfb
Compare
mdellweg
approved these changes
May 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The old docs should be deactivated on July 2024, as shown here.
This should be added manually for plugin which doesn't use plugin_template docs updates.
Preview
It looks like this (on every page):
[noissue]