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

Replacing '&' with '&' #3405

Merged
merged 1 commit into from
Oct 31, 2024
Merged

Conversation

apinnick
Copy link
Contributor

@apinnick apinnick commented Oct 31, 2024

What changes are you introducing?

Replacing & with &

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

Trying to fix broken XML build in Pantheon

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

Checklists

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

Please cherry-pick my commits into:

  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13
  • 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)
  • Foreman 3.6/Katello 4.8
  • Foreman 3.5/Katello 4.7 (Satellite 6.13; orcharhino 6.6/6.7)
  • We do not accept PRs for Foreman older than 3.5.

 Fixing broken XML build in Sat docs
@apinnick apinnick added Needs tech review Requires a review from the technical perspective style review done No issues from docs style/grammar perspective labels Oct 31, 2024
Copy link
Contributor

@Lennonka Lennonka left a comment

Choose a reason for hiding this comment

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

LGTM

@ekohl
Copy link
Member

ekohl commented Oct 31, 2024

I think this breaks the guide in upstream, so a difference in how Pantheon handles it vs plain asciidoc. Any thoughts on rewriting the code avoid needing this in the first place? I'm trying to find the branch where I already did that, but I can't find it now.

@apinnick
Copy link
Contributor Author

I think this breaks the guide in upstream, so a difference in how Pantheon handles it vs plain asciidoc. Any thoughts on rewriting the code avoid needing this in the first place? I'm trying to find the branch where I already did that, but I can't find it now.

@ekohl I am not sure what you mean by "breaks the guide in upstream". The upstream guides all render the code correctly.

display_info_for_hosts(FOREMAN_API + 'hosts?per_page=1&search=name~' + host_pattern)

@apinnick
Copy link
Contributor Author

If @ekohl 's PR is merged, we can close this PR.

@ekohl
Copy link
Member

ekohl commented Oct 31, 2024

I think you're right and I only looked at the diff, but forgot the HTML escaping is then still interpreted by the browser. Consider my objections gone. I don't mind merging this and then we can give my PR a proper review with the urgency behind it.

@apinnick apinnick merged commit b8ed219 into theforeman:master Oct 31, 2024
9 checks passed
@apinnick apinnick deleted the api-guide-fix branch October 31, 2024 14:35
apinnick added a commit that referenced this pull request Oct 31, 2024
Fixing broken XML build in Sat docs

(cherry picked from commit b8ed219)
@apinnick
Copy link
Contributor Author

Merged to 'master' and cherry-picked:
7e4d6f7..6c84233 3.12 -> 3.12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs tech review Requires a review from the technical perspective style review done No issues from docs style/grammar perspective
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants