Modularize managing packages

[maximiliankolb]

What changes are you introducing?

make the content of the "Managing packages" chapter modular + minor changes to reflect the Foreman/Katello 3.11+ WebUI

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

docs have to be modular to use it downstream.

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

The PR preview for b4212c0345180b6aab372bbe131d4d3fdb11acb1 is available at theforeman-foreman-documentation-preview-pr-3339.surge.sh

The following output files are affected by this PR:

• Managing_Hosts/index-foreman-el.html
• Managing_Hosts/index-katello.html
• Managing_Hosts/index-orcharhino.html
• Managing_Hosts/index-satellite.html

show diff

show diff as HTML

[maximiliankolb]

Any idea if we want to keep "json" for syntax highlighting?

• https://docs.redhat.com/en/documentation/red_hat_satellite/6.15/html/managing_hosts/managing-packages_managing-hosts#Installing_Packages_on_a_Host_managing-hosts
• https://docs.theforeman.org/nightly/Managing_Hosts/index-katello.html#upgrading-packages-on-a-host_managing-hosts
• (Managing packages is not yet in orcharhino live docs)

Are there any technical reasons to keep it? Afaik this is the only example:

$ rg --no-filename "^\[" | rg -i json | rg -v "^\[id"
[options="nowrap", json, subs="+quotes,verbatim,attributes"]

[apinnick]

@maximiliankolb

Now I understand that you are showing the output of a query. You're referring to 'snip_managing-packages-api.adoc`, right?

No, I do not see any point in using 'json'. Most output is fine as [source,text], IMO.

I would add a $ to the curl command in the preceding code block, however.

Any idea if we want to keep "json" for syntax highlighting? Are there any technical reasons to keep it? Afaik this is the only example:

$ rg --no-filename "^\[" | rg -i json | rg -v "^\[id"
[options="nowrap", json, subs="+quotes,verbatim,attributes"]

[maximiliankolb]

Yes, I was trying to show that "json" syntax highlighting does not work; implying that we could drop it. For now, I'd keep it as is. I would create a follow-up issue/PR if I see a reason to change that.

[maximiliankolb]

Merged to "master" and cherry-picked: 0bc035b62e..3cf1298d5e 3.12 -> 3.12 0373afcb6d..6298998ee8 3.11 -> 3.11