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.

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

Jump to bottom

Confusing EOL boilerplate on pages about newer releases #3949

Open
lucasw opened this issue Oct 2, 2023 · 1 comment · May be fixed by #4180
Open

Confusing EOL boilerplate on pages about newer releases #3949

lucasw opened this issue Oct 2, 2023 · 1 comment · May be fixed by #4180
Labels
help wanted Extra attention is needed

Comments

@lucasw
Copy link

lucasw commented Oct 2, 2023

https://docs.ros.org/en/foxy/Releases/Release-Jazzy-Jalisco.html is the first google search result for ros jazzy, but the top of the loaded page shows this:

You're reading the documentation for a version of ROS 2 that has reached its EOL (end-of-life), and is no longer officially supported. If you want up-to-date information, please have a look at Iron.

Jazzy Jalisco (codename ‘jazzy’; May, 2024)
...

ros_jazzy_foxy_eol

The message is referring to foxy of course, but the page is about jazzy, making it seem like it is EOL (despite not having been released yet)- if the EOL message clearly mentioned foxy instead of 'a version' it may help though would still be a little confusing.
@sloretz sloretz added the help wanted Extra attention is needed label Oct 12, 2023
@sloretz sloretz mentioned this issue Oct 12, 2023
Open
@Victor-Boyd
Copy link

I think this also boils over to other pages too like https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.html#building-the-site-locally as this does not change with the distro but with changes in the websites codebase.

Victor-Boyd added a commit to Victor-Boyd/ros2_documentation that referenced this issue Feb 21, 2024
@Victor-Boyd
Update doc version warning logic to exclude specific pages
2930a4f 
This commit modifies the Sphinx template logic to prevent the version warning message from appearing on the 'Contributing to ROS 2 Documentation' page and any pages within the 'Releases' section. The update is aimed at improving user experience by selectively displaying version warnings only where relevant.

Additionally, this change addresses and resolves issues ros2#3949 and ros2#3966, which were related to unwanted version warning messages on documentation pages deemed unnecessary for such alerts.

- Exclude '/Contributing/Contributing-To-ROS-2-Documentation.html' from version warning messages.
- Exclude any pages under '/Releases/' from version warning messages.
- Fixes ros2#3949 and ros2#3966.


Signed-off-by: Victor Boyd <115438604+Victor-Boyd@users.noreply.github.com>
@Victor-Boyd Victor-Boyd linked a pull request Feb 21, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update doc version warning logic to exclude specific pages Victor-Boyd/ros2_documentation
3 participants
@lucasw @sloretz @Victor-Boyd