Upstreamize Hammer guide #3197
Upstreamize Hammer guide #3197
Conversation
Lennonka
force-pushed
the
upstreamize-hammer-guide
branch
from
133a0a4 to
e1d10e4
Compare
|
I've made an attempt to rewrite the standalone installation procedure for upstream. |
Lennonka
force-pushed
the
upstreamize-hammer-guide
branch
from
28133c5 to
5b2767f
Compare
|
I've moved the assembly and modules where they belong. I suggest merging it as is and making further changes in other PRs. |
There was a problem hiding this comment.
- I noticed that many modules start with a level 2 heading. I am OK with this for now and can change it later in a follow-up PR.
- Unsure what "aqua-background" is for/ why "org" and "loc" has to be blue/yellow.
- Unsure if we want to keep some rather long examples of stdout.
I had a glance at most changes but not all. I appreciate the effort to bring it upstream. All my suggestion can be applied by you or me after merging.
Merging now and improving later is perfectly fine for me. Any other concerns or approval?
| ---- | ||
| :log_level: 'debug' | ||
| ---- | ||
| include::proc_increasing-the-logging-level-for-hammer.adoc[] |
There was a problem hiding this comment.
something that I'd like to avoid down the road. OK for now because the file already has level 2 headings.
It's sort of a flag that is introduced and explained in General information. It can be done differently, but for now I'm keeping it as is. |
There was a problem hiding this comment.
I'm not sure what to do with this file.
The problem is that the reference should be generated separately for Foreman, Katello, orcharhino, and Satellite because of branding and presence of Katello functionality in hammer help.
If I generate it in downstream and keep this file in upstream, our sync will overwrite it from upstream again. Therefore, it would be better to remove it in upstream.
However, if I don't include it in upstream, the build will not pass because it's required by master.adoc.
So the solution might be to exclude this file from syncing in downstream. Will you be able to do that in your sync too, @maximiliankolb?
There was a problem hiding this comment.
Yeah, I can handle this. No worries.
|
@Lennonka Just to ensure that I understand the intended workflow:
I ran this on orcharhino and got 95 files in total. Do you envision generating the references files on a minimal installation, with select plugins, or with all available plugins in Satellite/orcharhino? |
That is correct.
In Satellite, we have most plugins enabled AFAIK, I would include all plugins. For Foreman and Foreman+Katello I would go for generating the full help on an instance with all Hammer plugins enabled, either with or without Katello plugin accordingly. I think it's better to include all plugins regardless of what the user has enabled. Better to have it and not use it than not have it when needed :) |
There was a problem hiding this comment.
One small request.
I had a look at the built docs without reading/testing everything. I think we can merge this as is and then improve later.
I will have a closer look at this as soon as I integrate this into downstream docs.
As there are no other comments, I say LGTM; please merge after a final tiny edit & green GHA.
Thanks again @Lennonka for this effort! 🚀
pr-processor
bot
added
the
Waiting on contributor
Co-authored-by: Maximilian Kolb <[email protected]>
pr-processor
bot
added
Needs re-review
and removed
Waiting on contributor
Offering the Hammer CLI guide from Satellite to Foreman community Co-authored-by: Maximilian Kolb <[email protected]>
Offering the Hammer guide to upstream.
Please cherry-pick my commits into: