Split comments and commands in code blocks - Githubissues

theforeman / foreman-documentation

Documentation for the Foreman Project and its ecosystem

https://docs.theforeman.org

Creative Commons Attribution Share Alike 4.0 International

22 stars 95 forks source link

Split comments and commands in code blocks #3346

Closed maximiliankolb closed 1 month ago

maximiliankolb commented 1 month ago

What changes are you introducing?

Split comments and commands in code blocks.

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

to enable syntax highlighting, we need to remove comments from code blocks.

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

Only the last commit actually changes a code block; all other commits merely fix the code block macros in one way or another.
I am ok with squashing or keeping the commits as they are.

Checklists

[x] 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:

[x] Foreman 3.12/Katello 4.14 (Satellite 6.16)
[x] 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[bot] commented 1 month ago

The PR preview for 5fd410a3b5184e4298ea1fb64c489f7e8ab43c21 is available at theforeman-foreman-documentation-preview-pr-3346.surge.sh

The following output files are affected by this PR:

show diff as HTML

maximiliankolb commented 1 month ago

RE YAML syntax: I might have to adjust https://github.com/theforeman/foreman-documentation/pull/3334/files#diff-6c23392fe90f154654dfb074cbe1aa7a65c30dbd1412293c658f069fba6b9a38R59 + https://github.com/theforeman/foreman-documentation/pull/3334/files#diff-6c23392fe90f154654dfb074cbe1aa7a65c30dbd1412293c658f069fba6b9a38R95

maximiliankolb commented 1 month ago

Thanks Avital, much appreciated. Linkchecker failed due to temporary network issues; both URLs work. -> will merge.

maximiliankolb commented 1 month ago

Merged to "master" and painfully cherry-picked: 3cf1298d5e..9076850d8c 3.12 -> 3.12 6298998ee8..75751bad3b 3.11 -> 3.11