Skip to content

Split arguments in code blocks into separate lines #3701

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
Merged
merged 2 commits into from
Feb 27, 2025
Merged

Split arguments in code blocks into separate lines #3701

merged 2 commits into from
Feb 27, 2025

Conversation

maximiliankolb
Copy link
Contributor

What changes are you introducing?

  • split lines in code blocks
  • align anchors to current conventions (they're not published anywhere yet)

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

Minor mostly cosmetic follow-up to #3624

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

@maximiliankolb
Use dashes in anchor
3b58fe6 
Anchors were not in use:

$ rg -i "importing_and_exporting_content_to_project_server_for_flatpak"
$ rg -i "installing-flatpak-applications-on-project-hosts"
$ rg -i "setting-up-Flatpak-remote_for_Smartproxy"
@maximiliankolb
Use single argument per line in code blocks
a8286c6
@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 27, 2025
@github-actions GitHub Actions
Copy link

The PR preview for a8286c6 is available at theforeman-foreman-documentation-preview-pr-3701.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@aneta-petrova aneta-petrova added style review done No issues from docs style/grammar perspective Not yet reviewed and removed 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 27, 2025
@maximiliankolb maximiliankolb merged commit 1d00e5c into theforeman:master Feb 27, 2025
10 checks passed
@maximiliankolb maximiliankolb deleted the split_code_by_arg branch February 27, 2025 07:39
@maximiliankolb
Copy link
Contributor Author

Merged to "master" and cherry-picked to "3.14":
45cc124..c72a41f 3.14 -> 3.14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aneta-petrova aneta-petrova aneta-petrova approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@maximiliankolb @aneta-petrova