Skip to content

Fix titles "by using"#3185

Merged
Lennonka merged 2 commits into
theforeman:masterfrom
Lennonka:fix-titles-by-using
Aug 7, 2024
Merged

Fix titles "by using"#3185
Lennonka merged 2 commits into
theforeman:masterfrom
Lennonka:fix-titles-by-using

Conversation

@Lennonka
Copy link
Copy Markdown
Contributor

@Lennonka Lennonka commented Aug 5, 2024

  • 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.11/Katello 4.13
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9)
  • 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.

@Lennonka Lennonka linked an issue Aug 5, 2024 that may be closed by this pull request
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Aug 5, 2024

The PR preview for ab48a51 is available at theforeman-foreman-documentation-preview-pr-3185.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

Copy link
Copy Markdown
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 but I am not yet familiar with the theory behind this.

@maximiliankolb
Copy link
Copy Markdown
Contributor

diff LGTM but I am not yet familiar with the theory behind this.

OK, understood: #3141 (comment)

ekohl
ekohl previously requested changes Aug 6, 2024
Copy link
Copy Markdown
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

We have a mapping file guides/upstream_filename_to_satellite_link.json as well. As I noted in #3181, I don't exactly know how the mapping is determined but admittedly also didn't look it up in source code.

@pr-processor pr-processor Bot added the Waiting on contributor Requires an action from the author label Aug 6, 2024
@Lennonka Lennonka force-pushed the fix-titles-by-using branch from 064c8cd to 157ce80 Compare August 6, 2024 16:00
@pr-processor pr-processor Bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Aug 6, 2024
@Lennonka
Copy link
Copy Markdown
Contributor Author

Lennonka commented Aug 6, 2024

Updated the mapping file as well.

@Lennonka Lennonka requested a review from ekohl August 6, 2024 16:04
Comment thread web/releases/nightly.json
},
{
"title": "Configuring Hosts Using Ansible",
"title": "Configuring Hosts by Using Ansible",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Shouldn't this match exactly what's in guides/common/attributes-titles.adoc?

Suggested change
"title": "Configuring Hosts by Using Ansible",
"title": "Configuring hosts by using Ansible",

Or is that something we should fix separately since it looks like all others are using title case?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Separately.

@ekohl ekohl dismissed their stale review August 6, 2024 16:33

My concern has been addressed, but I don't have a complete picture if this wouldn't break other things right now.

@Lennonka
Copy link
Copy Markdown
Contributor Author

Lennonka commented Aug 7, 2024

@ekohl It will break UI links in Satellite, but that will be handled by: RedHatSatellite/foreman_theme_satellite#64

@Lennonka Lennonka merged commit d541c2f into theforeman:master Aug 7, 2024
@Lennonka Lennonka deleted the fix-titles-by-using branch August 7, 2024 01:33
Lennonka added a commit that referenced this pull request Aug 7, 2024
* Fix titles - add 'by'
* Shorten URL paths for updated guide titles
@Lennonka
Copy link
Copy Markdown
Contributor Author

Lennonka commented Aug 7, 2024

Cherry-picked:

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.

Usage of "X using Y" versus "do X by using Y"

3 participants