Skip to content

Documentation improvements#115

Merged
sabre1041 merged 11 commits into
validatedpatterns:mainfrom
p-rog:docs-update
Apr 7, 2026
Merged

Documentation improvements#115
sabre1041 merged 11 commits into
validatedpatterns:mainfrom
p-rog:docs-update

Conversation

@p-rog
Copy link
Copy Markdown
Collaborator

@p-rog p-rog commented Apr 1, 2026

README.md

  • Restructured the Components section into three tiers: Validated Patterns Framework (OpenShift GitOps/ArgoCD, VP Operator — previously not mentioned at all), Core ZTVP Components (always deployed), and
    Optional ZTVP Components (opt-in, commented out in values-hub.yaml by default)
  • Added missing components: cert-manager and ACS/RHACS were deployed but absent from the list
  • Moved to optional tier: Quay, NooBaa MCG, RHTAS, RHTPA, and OpenShift Pipelines — these were listed as always-on but are actually commented out by default
  • Marked externalized charts: RHBK, ZTWIM, Compliance Operator, and Quay are noted as (externalized chart) following PR feat: Externalize 5 charts to validatedpatterns repos #106
  • Added Architecture Overview section explaining the four-layer structure (VP Framework → Layer 0 Cluster Hardening → Layer 1 Identity & Secrets → Layer 2 Workloads & Supply Chain)
  • Fixed broken SSH URL in the git remote add command (github.com/ → github.com:)
  • Added links to docs/acs-deployment.md and docs/CONFIDENTIAL-CONTAINERS.md in the Use Cases section

docs/supply-chain.md

  • Added prerequisites callout at the top listing every values-hub.yaml section that must be uncommented before the supply chain use case works (Pipelines, RHTAS, RHTPA, Quay, NooBaa MCG operators and
    applications)

docs/multi-tier.md

  • Fixed incomplete sentence ("within this use case the external identity store" → "for the external identity store")
  • Added doc link on first reference to Red Hat Build of Keycloak

docs/DEVELOPMENT.md

  • Added "Accessing Credentials for Testing" section covering: how to extract the Vault root token, how to open the Vault Web UI, how to query secrets via vault kv get/list using oc exec (no local Vault binary
    needed), a reference table of all key secret paths organized by component, and a shortcut for reading ESO-synced Kubernetes Secrets directly

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Copy link
Copy Markdown
Collaborator

@sabre1041 sabre1041 left a comment

Choose a reason for hiding this comment

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

Looks good. A couple small suggestions

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
p-rog and others added 6 commits April 7, 2026 10:55
Co-authored-by: Andrew Block <andy.block@gmail.com>
Co-authored-by: Andrew Block <andy.block@gmail.com>
Co-authored-by: Andrew Block <andy.block@gmail.com>
Co-authored-by: Andrew Block <andy.block@gmail.com>
Co-authored-by: Andrew Block <andy.block@gmail.com>
Co-authored-by: Andrew Block <andy.block@gmail.com>
@p-rog
Copy link
Copy Markdown
Collaborator Author

p-rog commented Apr 7, 2026

Looks good. A couple small suggestions

Thanks @sabre1041 ! I've applied all your suggestions.

@p-rog p-rog requested a review from sabre1041 April 7, 2026 09:06
Copy link
Copy Markdown
Collaborator

@sabre1041 sabre1041 left a comment

Choose a reason for hiding this comment

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

LGTM

@sabre1041 sabre1041 merged commit 0c284b8 into validatedpatterns:main Apr 7, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants