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.

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

Merged
merged 1 commit into from
Aug 12, 2024

Conversation

Lennonka
Copy link
Contributor

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into: N/A

Copy link

github-actions bot commented Aug 12, 2024

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:

show diff

show diff as HTML

guides/common/attributes-satellite.adoc Outdated Show resolved Hide resolved
@pr-processor pr-processor bot added the Waiting on contributor Requires an action from the author label Aug 12, 2024
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Aug 12, 2024
@Lennonka Lennonka requested a review from ekohl August 12, 2024 14:59
@@ -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.

@Lennonka
Copy link
Contributor Author

I've updated the commit message to reflect the changes.

@Lennonka Lennonka merged commit fbd978d into theforeman:master Aug 12, 2024
8 of 9 checks passed
@Lennonka Lennonka deleted the add-comment-to-update-ds branch August 12, 2024 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants