Skip to content

docs: update documentation around version warning banner #10877

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Nov 8, 2023
Merged

docs: update documentation around version warning banner #10877

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2ce740f
update documentation around version warning banner
jertel Oct 30, 2023
c46e748
match indentation from previous author
jertel Oct 30, 2023
a4aff35
trim trailing whitespace
jertel Oct 30, 2023
25b2fe8
Update docs/user/versions.rst
jertel Nov 7, 2023
cc89be0
Update docs/user/versions.rst
jertel Nov 7, 2023
73ec039
remove obsolete note
jertel Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 13 additions & 20 deletions docs/user/versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,31 +149,24 @@ Version Control Support Matrix
Version warning
---------------

This is a banner that appears on the top of every page of your docs that aren't stable or latest.
This banner has a text with a link redirecting the users to the latest version of your docs.
A banner can be automatically displayed to notify viewers that there may be
a more stable version of the documentation available. Specifically:

This feature is disabled by default on new projects,
you can enable it in the admin section of your docs (:guilabel:`Admin` > :guilabel:`Advanced Settings`).
- When the ``latest`` version is being shown, and there's also a ``stable`` version active and not hidden,
then the banner will remind the viewer that some of the documented features may not yet be
available, and suggest that the viewer switch to the ``stable`` version.
- When a version is being shown that is not the ``stable`` version, and there's a ``stable``
version available, then the banner will suggest that the viewer switch to the ``stable`` version
to see the newest documentation.

.. note::

The banner will be injected in an HTML element with the ``main`` role or in the ``main`` tag.
For example:

.. code-block:: html

<div role="main">
<!-- The banner would be injected here -->
...
</div>
This feature is enabled by default on projects using the new beta addons.
The beta addons can be enabled by using ``build.commands`` config key or via the new beta dashboard (https://beta.readthedocs.org) going to the admin section of your docs (:guilabel:`Admin` > :guilabel:`Advanced Settings`)

.. code-block:: html

<main>
<!-- The banner would be injected here -->
...
</main>
.. note::

An older version of this feature is currently only available to projects that have already enabled it.
When the updated feature development is finished the toggle setting will be enabled for all projects.

Redirects on root URLs
----------------------
Expand Down