feat: add GitOps installation procedures#3141
Open
gtrivedi88 wants to merge 8 commits into
Open
Conversation
gtrivedi88
requested review from
a team,
deerskindoll and
mkuznyetsov
as code owners
|
🎊 Navigate the preview: https://6a46521ffd803f1874cc93b4--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
gtrivedi88
force-pushed
the
gitops-install-procedures
branch
from
b3c7d7f to
8af33c4
Compare
Add two new procedures for deploying Che using Argo CD (GitOps), per SME feedback that production deployments use GitOps, not CLI or web console. New files: - proc_deploying-che-using-gitops.adoc: connected cluster GitOps deployment with single Argo CD Application - proc_deploying-che-using-gitops-in-a-restricted-environment.adoc: air-gapped GitOps deployment with mirrored registry Modified files: - con_installation-overview.adoc: add GitOps as deployment method - nav.adoc: add "Deploy using GitOps" section before OpenShift Tested end-to-end on OCP 4.21 ROSA cluster (Jul 2, 2026). Critical sync option: SkipDryRunOnMissingResource=true Content body is identical to downstream devspaces-documentation proc_deploying-devspaces-using-gitops*.adoc (minus downstream-only metadata wrappers). Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
- Per-page persona callout added to all 23 install pages - Links to discover:roles-and-tasks.adoc for role definitions Co-authored-by: Cursor <cursoragent@cursor.com>
'This page is for platform administrators.' →
'This page is for platform administrators who install, configure,
and manage {prod-short} on {orch-name} clusters.'
Matches Google GKE documentation style.
Co-authored-by: Cursor <cursoragent@cursor.com>
Replace hardcoded persona text with include::discover:partial$snip_persona-admin.adoc[] in all 23 install pages. Partials created in Discover PR eclipse-che#3131. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
pass:[<!-- vale -->] HTML comments get linted as content, causing false RedHat.Spacing errors on 'RedHat.Spelling'. AsciiDoc comments (// vale ...) are the correct format for Vale control. Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
gitops-install-procedures
branch
from
8af33c4 to
c9a12e3
Compare
Same fix as Upgrade PR eclipse-che#3142 — the top-level nav already says 'Install', so nesting all procedures under another 'Install Che' wrapper is redundant. Deployment sections (GitOps, OpenShift, Kubernetes, local, restricted) are now top-level nav items. Co-authored-by: Cursor <cursoragent@cursor.com>
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
1 participant
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.
Summary
What changed
modules/install/pages/proc_deploying-che-using-gitops.adocmodules/install/pages/proc_deploying-che-using-gitops-in-a-restricted-environment.adocmodules/install/pages/con_installation-overview.adocmodules/install/nav.adocWhy
SME feedback: production deployments use GitOps (Argo CD), not CLI or web console. The GitOps procedure should be the primary installation method.
Two procedures cover:
Cluster testing
Tested end-to-end on OCP 4.21 ROSA cluster (Jul 2, 2026):
SkipDryRunOnMissingResource=trueworksDownstream alignment
Content body is identical to downstream
devspaces-documentationprocedures on thegitops-install-proceduresbranch. Only metadata wrappers differ (:_content-type:vs:_mod-docs-content-type:, no_{context}suffixes, Antora xrefs vslink:macros).Test plan
Made with Cursor