Create an assembly per each LB config use case #3008
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The PR preview for 439f243 is available at theforeman-foreman-documentation-preview-pr-3008.surge.sh The following output files are affected by this PR: |
Includes renaming orcharhino-specific prereq section
asteflova
force-pushed
the
LB_config_assemblies
branch
from
860a3d2
to
0c66046
Compare
9 tasks
asteflova
changed the title
Lennonka
requested changes
May 15, 2024
guides/common/modules/ref_prerequisites-configuring-smartproxyservers-for-load-balancing.adoc
Outdated
Show resolved
Hide resolved
...figuring-smartproxyservers-with-default-ssl-certificates-for-load-balancing-with-puppet.adoc
Outdated
Show resolved
Hide resolved
...figuring-smartproxyservers-with-default-ssl-certificates-for-load-balancing-with-puppet.adoc
Outdated
Show resolved
Hide resolved
pr-processor
bot
added
Waiting on contributor
Co-authored-by: Zuzana Lena Ansorgová <zuansorg@redhat.com>
pr-processor
bot
added
Needs re-review
and removed
Waiting on contributor
Lennonka
reviewed
May 20, 2024
...nfiguring-smartproxyservers-with-custom-ssl-certificates-for-load-balancing-with-puppet.adoc
Outdated
Show resolved
Hide resolved
Lennonka
added
Waiting on contributor
Lennonka
requested changes
May 20, 2024
guides/common/modules/ref_prerequisites-configuring-smartproxyservers-for-load-balancing.adoc
Outdated
Show resolved
Hide resolved
pr-processor
bot
added
Needs re-review
and removed
Waiting on contributor
asteflova
added a commit
that referenced
this pull request
May 23, 2024
* Create assembly files for LB config scenarios * Add LB config assembly intros * Add LB config prerequisites Includes renaming orcharhino-specific prereq section * Include managing Puppet limitations in each related LB assembly --------- Co-authored-by: Zuzana Lena Ansorgová <zuansorg@redhat.com> (cherry picked from commit 35c8814)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current way the procedures for configuring LB are documented is rather confusing -- a lot of different procedures are included within one assembly (yes Puppet/no Puppet, custom certs/default certs), and it takes quite some time to figure out which procedures are related to which use case. With this PR, I aim to create multiple assemblies where each assembly guides users through their scenario from beginning to end:
Users can now find all related procedures and other information (prerequisites, limitations) under one assembly heading.
The number of xrefs leading to other procedures has been reduced; there is no need for them now.
Each assembly now clearly links to support limitations (this is to address https://bugzilla.redhat.com/show_bug.cgi?id=2251030 ).
While I was at it, I also reworded procedure introductions to make them more descriptive and user-focused (mainly by removing self-referential wording like "This section/procedure")
I am familiar with the contributing guidelines.
Please cherry-pick my commits into: