docs: Implement new home page pattern and address feedback#527
Open
erinecon wants to merge 21 commits into
Open
docs: Implement new home page pattern and address feedback#527erinecon wants to merge 21 commits into
erinecon wants to merge 21 commits into
Conversation
srbouffard
reviewed
May 27, 2026
srbouffard
reviewed
May 27, 2026
srbouffard
reviewed
May 27, 2026
…s/home-page-table-format
…proxy-operator into docs/home-page-table-format
Thanhphan1147
approved these changes
Jun 2, 2026
srbouffard
reviewed
Jun 2, 2026
srbouffard
approved these changes
Jun 2, 2026
This file contains hidden or 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
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.
What this PR does
Implements the new home page pattern to the HAProxy charm RTD.
After discussing this PR with Daniele, he had some additional comments on the organization (specifically the load balancing tutorials) and the value behind some of the smaller pages (specifically the upgrade guide). So this PR also addresses those concerns:
channel).Why we need it
The new home page pattern provides our readers with more clarity and understanding of the domains of concern for the HAProxy charm. Readers now get a high-level overview of the topics and concepts covered in the documentation.
Checklist
docs/changelog.mdwith user-relevant changesdocs/release-notes/artifacts. If no change artifact is necessary, I tagged the PR with the labelno-release-note.(e.g., in
.github/workflows/integration_tests.yaml, ensure themoduleslist is correct)terraform fmtpasses andtflintreports no errorsI used AI to interrogate the domains and themes in the documentation, using the initial groupings as a starting place. I also used AI to review the changes locally.