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

Add comment to update json in downstream #3209

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Add comment to update json in downstream #3209

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions guides/common/attributes-satellite.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
:BaseURL: {RHDocsBaseURL}red_hat_satellite/{ProjectVersion}/html-single/

// URLs (published on Red Hat Portal)
// IMPORTANT: When you change any guide URLs, also update the following:
// - guides/upstream_filename_to_satellite_link.json
// - lib/foreman_theme_satellite/documentation.rb in RedHatSatellite/foreman_theme_satellite
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually you don't have to update this one right away. Once the new TOC will be generated, it will detect the incompatible links automatically.
To fix the incompatibility a pr with the new toc and a fix to documentation.rb should be created.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally we would sync that mapping so we don't maintain the same thing in 3 places, but I explicitly asked for this because it tracks the related places. I don't think a docs writer monitors foreman_theme_satellite and may not be aware of it. After RedHatSatellite/foreman_theme_satellite#58 it will have a mapping that must be maintained.

// - downstream_filename_to_link.json in downstream
:AdministeringDocURL: {BaseURL}administering_red_hat_satellite/index#
:ConfiguringLoadBalancerDocURL: {BaseURL}configuring_capsules_with_a_load_balancer/index#
:ContentManagementDocURL: {BaseURL}managing_content/index#
Expand Down
Loading