-
Notifications
You must be signed in to change notification settings - Fork 95
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.
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
Add comment to update json in downstream #3209
Conversation
01d1928
to
c05e5b6
Compare
The PR preview for 6636265 is available at theforeman-foreman-documentation-preview-pr-3209.surge.sh The following output files are affected by this PR: |
c05e5b6
to
6fca2e7
Compare
@@ -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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
6fca2e7
to
6636265
Compare
I've updated the commit message to reflect the changes. |
Please cherry-pick my commits into: N/A