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

Change capitalization of guide titles #2874

Merged

Conversation

apinnick
Copy link
Contributor

@apinnick apinnick commented Mar 12, 2024

  • Change guide title capitalization from title case to sentence case

Please cherry-pick my commits into:

  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (planned Satellite 6.15)
  • 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)
  • Foreman 3.4/Katello 4.6 (EL8 only)
  • Foreman 3.3/Katello 4.5 on EL7 & EL8 (Satellite 6.12 on EL8 only; orcharhino 6.4/6.5 on EL8 only)
  • We do not accept PRs for Foreman older than 3.3.

Copy link

github-actions bot commented Mar 12, 2024

The PR preview for 32b8ff9 is available at theforeman-foreman-documentation-preview-pr-2874.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

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.

diff LGTM. Any other comments? Else I'll merge as is.

@apinnick apinnick force-pushed the change-guide-title-capitalization branch 3 times, most recently from b69762e to 045934a Compare March 12, 2024 13:17
- Change guide title capitalization from title case to sentence case
- Shortened a few names where the product name did not seem necessary
- Updated d/s URLs

Signed-off-by: Avital Pinnick <apinnick@redhat.com>
@apinnick apinnick force-pushed the change-guide-title-capitalization branch from 045934a to 42d8052 Compare March 12, 2024 13:20
@apinnick
Copy link
Contributor Author

@maximiliankolb I just noticed that the docinfo.xml files are not using the attributes. So I need to fix those as well.

@apinnick
Copy link
Contributor Author

@maximiliankolb I was mistaken. All the docinfo.xml files have the doc title attributes, so they are fine. Only change I made was a level offset fix to an 'include'. Please review.

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.

LGTM. I assume you have tested the URLs for Satellite docs? Ping me and I will merge + cherry-pick both commits.

@apinnick
Copy link
Contributor Author

LGTM. I assume you have tested the URLs for Satellite docs? Ping me and I will merge + cherry-pick both commits.

@maximiliankolb I can't test the URLs before this PR is merged because they have to be configured in Pantheon. When this PR is merged and synced with downstream, then I will update the titles in Pantheon so that the new URLs work.

@maximiliankolb maximiliankolb merged commit 72097c1 into theforeman:master Mar 12, 2024
8 checks passed
@maximiliankolb
Copy link
Contributor

Merged to "master" and cherry-picked:
358a144..7b553e7 3.10 -> 3.10
e02e4b1..997ca5a 3.9 -> 3.9

@apinnick apinnick deleted the change-guide-title-capitalization branch March 12, 2024 15:28
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.

None yet

2 participants