Update Hammer reference for 3.12/6.16

asteflova commented 2 months ago

What changes are you introducing?

I'm adding Hammer reference generated based on Foreman 3.12/Satellite 6.16 by using guides/scripts/generate-hammer-reference.sh.

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

The script provides an automated way of generating an up-to-date list of Hammer commands, subcommands, and options for a particular Foreman version.

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

We are not supposed to modify the generated assembly and modules, but I had to fix a couple of build failures related to apparent attributes like %{package}. I addressed this in a separate commit.

I found one other small issue with the generated content but because it has been there in earlier d/s-only versions of the guide (see the description for --subscriptions in 3.2.2. activation-key add-subscription), I suggest to leave this as is. The proper fix is to update the script.

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)
[ ] 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 2 months ago

The PR preview for e949e19fc5f47c68946810e941df1037f0868d4a is available at theforeman-foreman-documentation-preview-pr-3311.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

asteflova commented 2 months ago

Vale can't check the diff:

reviewdog: fail to get diff: GET https://api.github.com/repos/theforeman/foreman-documentation/pulls/3311: 406 Sorry, the diff exceeded the maximum number of lines (20000)

so I propose to ignore the Vale check. The content is generated from --help pages anyway and those are not subject to style guides and Vale checks.

asteflova commented 2 months ago

And it looks like the script generates "Satellite" everywhere, understandably. I suppose that means I should exclude the reference for non-Satellite builds. Thoughts?

Lennonka commented 2 months ago

And it looks like the script generates "Satellite" everywhere, understandably. I suppose that means I should exclude the reference for non-Satellite builds. Thoughts?

Thank you for taking on this task.

Actually, the idea was to update the reference directly in downstream for Satellite and orcharhino, and keep upstream for Foreman only because one needs the branded output from Hammer help. I suggest that you close this PR and re-open it downstream.

I have yet to ensure that our sync will not overwrite the reference modules. cc @maximiliankolb I forgot about those! :) common/modules/ref_hammer-* should do the trick

theforeman / foreman-documentation