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

Prevent asterisk substitution in a code block (3.10 and earlier) #3283

Closed asteflova closed 2 months ago

asteflova commented 2 months ago

What changes are you introducing?

A minor change to make sure the asterisks in a command included in a code block are preserved.

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

Right now, the asterisks are interpreted as bold text.

Screenshot from 2024-09-13 18-59-39

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

https://github.com/theforeman/foreman-documentation/pull/3282 applies the same fix on 3.11 and later.

Checklists

Please cherry-pick my commits into:

github-actions[bot] commented 2 months ago

The PR preview for d69d4fd5b6745a45a1bcbb14cfe1968f83b97a05 is available at theforeman-foreman-documentation-preview-pr-3283.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

asteflova commented 2 months ago

No change from the technical point of view so I'm setting the tech review done label.

asteflova commented 2 months ago

Merged to "3.10" and cherry-picked:

4dc8a8393f..9a12c20617 3.9 -> 3.9 674c594683..3e6fdef3a9 3.8 -> 3.8 72477d8629..9bda7fedd3 3.7 -> 3.7 241ef1d8c1..3bea1ac680 3.6 -> 3.6 ec9440720a..5f5c6de9b8 3.5 -> 3.5