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

Update xrefs that are broken in satellite d/s builds #3692

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aneta-petrova
Copy link
Member

What changes are you introducing?

Adding labels to a few xref cross-links.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

https://issues.redhat.com/browse/SAT-31298 reports a few xrefs that appear broken in Satellite builds. Satellite d/s docs tooling doesn't support multiple xrefs included on a single line, unless their labels are explicitly defined.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Another solution would be to include each xref on a separate line, for example as bullet point lists. But adding the label should work too (example: 9.4 Setting the global out-of-sync interval).

Checklists

  • 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:

  • Foreman 3.14/Katello 4.16
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • We do not accept PRs for Foreman older than 3.7.

@github-actions github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Feb 25, 2025
Copy link
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

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

This looks like an issue with downstream docs frameworks. As far as I can tell, it previously affected two xrefs in a single line. So far, the solution was always to use bullet points (one per link).

I like this much better than adding titles to xrefs. Would you mind investigating this?

@pr-processor pr-processor bot added Waiting on contributor Requires an action from the author and removed Not yet reviewed labels Feb 25, 2025
@aneta-petrova aneta-petrova removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels Feb 25, 2025
@aneta-petrova
Copy link
Member Author

This looks like an issue with downstream docs frameworks. As far as I can tell, it previously affected two xrefs in a single line. So far, the solution was always to use bullet points (one per link).

I like this much better than adding titles to xrefs. Would you mind investigating this?

Sure, I can change all of these to bullet points. But first I'd like to know why you prefer bulleted lists :) I'm not saying no, it's just that when I compared the two options, bullet points seemed to make the text longer and used up a lot more words, which is why I decided to go with the labels. I don't have a strong preference myself but would like to understand your point of view better. @maximiliankolb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs style review Requires a review from docs style/grammar perspective Waiting on contributor Requires an action from the author
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants