Skip to content

RHIDP-9078: Add an architecture section to documentation#1792

Merged
deerskindoll merged 7 commits intoredhat-developer:mainfrom
jmagak:RHIDP-9078-Add-an-architecture-section-to-documentation
Feb 17, 2026
Merged

RHIDP-9078: Add an architecture section to documentation#1792
deerskindoll merged 7 commits intoredhat-developer:mainfrom
jmagak:RHIDP-9078-Add-an-architecture-section-to-documentation

Conversation

@jmagak
Copy link
Copy Markdown
Member

@jmagak jmagak commented Feb 12, 2026 •
edited
Loading

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): 1.8, 1.9, main

Issue: RHIDP-9078

Preview:

2. Plan your deployment with system architecture
3. Achieve high availability with database and cache layers

@rhdh-bot
Copy link
Copy Markdown
Collaborator

rhdh-bot commented Feb 13, 2026 •
edited
Loading

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1792/ @ 02/17/26 11:39:15

@jmagak jmagak requested a review from durandom February 13, 2026 13:36
@jmagak jmagak force-pushed the RHIDP-9078-Add-an-architecture-section-to-documentation branch from 8067c6d to 5a38963 Compare February 16, 2026 08:47
durandom
durandom reviewed Feb 16, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@durandom durandom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@durandom
Copy link
Copy Markdown
Member

durandom commented Feb 16, 2026

Two small nitpicks:

  1. Redis caches more than TechDocs — The text says Redis caches "TechDocs rendered documentation", but it's used more broadly via the CacheManager (e.g. catalog entities). The architecture diagram also shows both "TechDocs" and "Entities" under Redis. Consider something like "caching frequently accessed data such as rendered TechDocs and catalog entities".

  2. External integrations are examples — "Git repositories, CI/CD platforms, and other integrations" could benefit from making it explicit that these are just the most common examples, e.g. "such as Git repositories, CI/CD platforms, and monitoring tools" or similar phrasing that signals these are non-exhaustive.

@jmagak jmagak force-pushed the RHIDP-9078-Add-an-architecture-section-to-documentation branch from 5a38963 to 6b52d50 Compare February 16, 2026 14:49
@jmagak jmagak force-pushed the RHIDP-9078-Add-an-architecture-section-to-documentation branch from 6b52d50 to 8067c6d Compare February 16, 2026 19:24
@jmagak jmagak added Peer review needed 📖 Technical review done ⛅ Any procedure has been succesfully tested and removed Technical review needed 🔩 Test all the procedures labels Feb 16, 2026
@jmagak jmagak force-pushed the RHIDP-9078-Add-an-architecture-section-to-documentation branch from 4b1aab3 to 1d27dc4 Compare February 16, 2026 21:00
@jmagak jmagak force-pushed the RHIDP-9078-Add-an-architecture-section-to-documentation branch from 1d27dc4 to 6a0d594 Compare February 16, 2026 22:31
@jmagak jmagak force-pushed the RHIDP-9078-Add-an-architecture-section-to-documentation branch from 6a0d594 to e0e2672 Compare February 17, 2026 08:38
pabel-rh
pabel-rh reviewed Feb 17, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@pabel-rh pabel-rh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few comments

Comment thread modules/about/con-achieve-high-availability-with-database-and-cache-layers.adoc Outdated
Comment thread modules/about/con-achieve-high-availability-with-database-and-cache-layers.adoc Outdated
Comment thread modules/about/con-achieve-high-availability-with-database-and-cache-layers.adoc Outdated
Comment thread modules/about/con-achieve-high-availability-with-database-and-cache-layers.adoc Outdated
Comment thread modules/about/con-achieve-high-availability-with-database-and-cache-layers.adoc Outdated
Comment thread modules/about/con-plan-your-deployment-with-system-architecture.adoc Outdated
Comment thread modules/about/con-plan-your-deployment-with-system-architecture.adoc Outdated
Comment thread modules/about/con-plan-your-deployment-with-system-architecture.adoc Outdated
Comment thread modules/about/con-plan-your-deployment-with-system-architecture.adoc Outdated
Comment thread modules/about/con-plan-your-deployment-with-system-architecture.adoc Outdated
@jmagak jmagak force-pushed the RHIDP-9078-Add-an-architecture-section-to-documentation branch from e0e2672 to 58923ef Compare February 17, 2026 11:33
@jmagak jmagak force-pushed the RHIDP-9078-Add-an-architecture-section-to-documentation branch from 58923ef to cc0595b Compare February 17, 2026 11:34
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Feb 17, 2026

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@jmagak
Copy link
Copy Markdown
Member Author

jmagak commented Feb 17, 2026

/cherry-pick release-1.8

@openshift-cherrypick-robot
Copy link
Copy Markdown
Contributor

openshift-cherrypick-robot commented Feb 17, 2026

@jmagak: once the present PR merges, I will cherry-pick it on top of release-1.8 in a new PR and assign it to you.

Details

In response to this:

/cherry-pick release-1.8

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@jmagak
Copy link
Copy Markdown
Member Author

jmagak commented Feb 17, 2026

/cherry-pick release-1.9

@openshift-cherrypick-robot
Copy link
Copy Markdown
Contributor

openshift-cherrypick-robot commented Feb 17, 2026

@jmagak: once the present PR merges, I will cherry-pick it on top of release-1.9 in a new PR and assign it to you.

Details

In response to this:

/cherry-pick release-1.9

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@deerskindoll deerskindoll merged commit 98fbf38 into redhat-developer:main Feb 17, 2026
6 checks passed
@openshift-cherrypick-robot
Copy link
Copy Markdown
Contributor

openshift-cherrypick-robot commented Feb 17, 2026

@jmagak: new pull request created: #1799

Details

In response to this:

/cherry-pick release-1.8

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Feb 17, 2026
Merged
@openshift-cherrypick-robot
Copy link
Copy Markdown
Contributor

openshift-cherrypick-robot commented Feb 17, 2026

@jmagak: new pull request created: #1800

Details

In response to this:

/cherry-pick release-1.9

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Feb 17, 2026
Merged
@jmagak
Copy link
Copy Markdown
Member Author

jmagak commented Feb 17, 2026

/cherry-pick release-1.7

@openshift-cherrypick-robot
Copy link
Copy Markdown
Contributor

openshift-cherrypick-robot commented Feb 17, 2026

@jmagak: new pull request created: #1802

Details

In response to this:

/cherry-pick release-1.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Feb 17, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pabel-rh pabel-rh pabel-rh approved these changes

+1 more reviewer

@durandom durandom durandom left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Peer review done 📘 Ready to merge 💂 Technical review done ⛅ Any procedure has been succesfully tested

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jmagak @rhdh-bot @durandom @openshift-cherrypick-robot @pabel-rh @deerskindoll