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

Fix broken links in Installing Proxy #3327

Merged
merged 6 commits into from
Oct 8, 2024
Merged

Fix broken links in Installing Proxy #3327

merged 6 commits into from
Oct 8, 2024

Conversation

asteflova
Copy link
Member

@asteflova asteflova commented Sep 27, 2024 •
edited
Loading

What changes are you introducing?

Fixing several broken links found in Installing Proxy.

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

We received a list of broken links in https://issues.redhat.com/browse/SAT-27794. About half of these actually needed fixing, the other ~half was just references to guides for a future d/s release.

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

EDIT: Apart from just fixing the broken links, I also changed some of them into xrefs in cases when the target was in the same guide.

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.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.

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 27, 2024 •
edited
Loading

The PR preview for a815ae0 is available at theforeman-foreman-documentation-preview-pr-3327.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@asteflova
Copy link
Member Author

Tech review not necessary because this is just about fixing links > tech review done

We can ignore the Vale check: lowercase dns is part of a section ID.

@asteflova asteflova added tech review done No issues from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels Sep 27, 2024
@maximiliankolb
Copy link
Contributor

@asteflova Please rebase to "master" and resolve the merge conflict.

maximiliankolb
maximiliankolb requested changes Oct 4, 2024
View reviewed changes
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.

Mostly LGTM; one link is broken and one title is slightly off.

guides/common/modules/con_configuring-project-with-external-idm-dns.adoc Outdated Show resolved Hide resolved
guides/common/modules/con_configuring-project-with-external-idm-dns.adoc Outdated Show resolved Hide resolved
guides/common/modules/ref_smart-proxy-port-and-firewall-requirements.adoc Outdated Show resolved Hide resolved
guides/common/modules/snip_host-registration-steps.adoc Outdated Show resolved Hide resolved
@pr-processor pr-processor bot added Waiting on contributor Requires an action from the author and removed Not yet reviewed labels Oct 4, 2024
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Oct 7, 2024
maximiliankolb
maximiliankolb reviewed Oct 7, 2024
View reviewed changes
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.

one tiny suggestion to adjust capitalization; and I believe that I found one link that we should adjust. rest LGTM; will re-review.

guides/common/modules/con_registering-hosts-and-setting-up-host-integration.adoc Show resolved Hide resolved
guides/common/modules/ref_smart-proxy-port-and-firewall-requirements.adoc Outdated Show resolved Hide resolved
maximiliankolb
maximiliankolb approved these changes Oct 8, 2024
View reviewed changes
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.

Thanks Anet, LGTM

@maximiliankolb maximiliankolb added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Oct 8, 2024
@asteflova asteflova merged commit 1d2bf06 into theforeman:master Oct 8, 2024
8 of 9 checks passed
asteflova added a commit that referenced this pull request Oct 8, 2024
@asteflova
Fix broken links in Installing Proxy (#3327)
bd9d5c7 
* Fix reported broken links
* Replace a few external links with xrefs
* Adjust a few of anchors

---------

Co-authored-by: Maximilian Kolb <[email protected]>
(cherry picked from commit 1d2bf06)
@asteflova
Copy link
Member Author

Merged to "master" and cherry-picked:

c9e8b85..bd9d5c7 3.12 -> 3.12

@asteflova asteflova deleted the SAT-27794_fix_broken_links branch October 8, 2024 07:00
evgeni
evgeni reviewed Oct 8, 2024
View reviewed changes
guides/common/modules/con_registering-hosts-and-setting-up-host-integration.adoc
[id="registering_hosts_to_server_{context}"]
[id="registering-hosts-and-setting-up-host-integration_{context}"]
Copy link
Member

@evgeni evgeni Oct 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

This broke UI links for Satellite, see RedHatSatellite/foreman_theme_satellite#90 / https://github.com/RedHatSatellite/foreman_theme_satellite/actions/runs/11230353017/job/31217571867?pr=90

Copy link
Member Author

Choose a reason for hiding this comment

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

Adding a secondary ID might help. If not, I'll revert this change.

Copy link
Member

Choose a reason for hiding this comment

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

I can also update the mapping in foreman_theme_satellite (but that'll require a new release etc).

Not sure what the preferred solution is. Keeping old ids (as secondary) seems like tech dept?

Copy link
Member Author

Choose a reason for hiding this comment

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

I wouldn't mind keeping old IDs (although we might want to clean them up eventually in coordination with changes to the UI links). A bigger issue is that the secondary links seem to only work with RH d/s html-single builds, not the multi-page build linked from the UI.

I'm working on this in #3358, which might indeed turn out to be a revert of the ID change (with a note as a warning for posterity because I'm pretty sure this would otherwise happen again).

@asteflova asteflova mentioned this pull request Oct 8, 2024
Merged
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@evgeni evgeni evgeni left review comments

@maximiliankolb maximiliankolb maximiliankolb approved these changes

Assignees
No one assigned
Labels
style review done No issues from docs style/grammar perspective tech review done No issues from the technical perspective
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@asteflova @maximiliankolb @evgeni