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

Distributions pages should not be versioned with distros #3966

Open
sloretz opened this issue Oct 12, 2023 · 0 comments
Open

Distributions pages should not be versioned with distros #3966

sloretz opened this issue Oct 12, 2023 · 0 comments
Labels
backlog

Comments

@sloretz
Copy link
Contributor

sloretz commented Oct 12, 2023

Context #3949 Brings up a confusing issue where the EOL header is applied to an upcomming ROS distro. The cause of this problem is the distribution pages are versioned by ROS distro like all of the other documentation. They shouldn't be versioned. They should be in their own unversioned section. This is a ticket to figure out where that should be, and how it could be done.
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 <[email protected]>
@Victor-Boyd Victor-Boyd mentioned this issue Feb 21, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backlog
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sloretz