chore(docs): add 8.10 deployment journey IA proposal#6275
Conversation
|
Feedback incorporated — Hamza (round 1)§1 Plan — reorder and rename
§1 Plan — paradigm tab model (Option B)
§2 Baseline — full restructure into sequential numbered stepsOld shape had wrapper sections (Install / Common configuration) with paradigm sub-trees. New shape is flat numbered steps in logical provisioning order:
Items removed from §2
|
leiicamundi
left a comment
There was a problem hiding this comment.
Thanks for putting this together — the journey-shaped direction, the competitor benchmarking, and the exhaustive page-by-page mapping make a strong foundation, and the risk-ordered phasing is the right instinct. A few cross-cutting suggestions, with specifics inline:
- Anchor the diagnosis to an explicit baseline. The "current" shape described matches the Next (8.10)
sidebars.js, not the released 8.9 sidebar; stating that up front prevents a false mismatch when reviewers check the live docs. - A couple of the flagged "problems" may be false positives — the OpenShift/ROSA "duplication" and the dual-region "misfiling" both look like distinct-target / deliberate-split situations on closer reading. Details inline.
- Re-verify the external references (
#5996–#5999,#7617,#8492); several resolve to unrelated or closed/held work today. - Evaluate navigability with a real draft. The structure is currently a written tree — a navigable preview (a
sidebars.jsbranch / preview deploy of the reorganized sidebar) would let us judge findability and click-depth directly, which is hard to do from a mental model. - Size the work. The 50+/45+/15+ scope needs rough effort and owners per section to be plannable before GA.
None of this blocks the direction — these notes are about making the proposal easier to validate and land incrementally.
leiicamundi
left a comment
There was a problem hiding this comment.
A follow-up focused on the constructive / structural side, complementing the earlier factual notes. These are about the one area where the proposal risks reintroducing the problem it sets out to fix, plus two places where it's already aligned with good practice and worth reinforcing. Framed through Diátaxis (Tutorial / How-to / Reference / Explanation), which gives a per-page test — "what single user need does this serve?" — that the briefs can apply directly.
A concrete Diátaxis-shaped variant (to avoid reinventing the wheel)Most of the structural questions this proposal is working through — where do "concepts" stop and "reference" begin, why a catch-all section keeps forming, whether planning material is a journey step or standing content — are exactly what the Diátaxis framework already solves. Rather than deriving a bespoke taxonomy from competitor sites, it may be worth adopting Diátaxis's four needs (Tutorial / How-to / Reference / Explanation) as the organizing principle: it's a known, documented system, so the team inherits its rules and rationale instead of re-litigating them per section. Applied to this proposal, the journey spine stays almost entirely intact — the only real change is splitting the one section that mixes two needs: What changes vs. the current §5:
The payoff isn't a different tree — it's the per-page test the framework gives you: "what single need does this page serve — learn, do, look up, or understand?" That one question replaces section-by-section debate with a repeatable rule the content briefs can apply directly, and it's the missing criterion for deciding what goes where when the next ambiguous page shows up. Everything the proposal already does well — the journey spine, the exhaustive page mapping, the competitor patterns (which are themselves largely Diátaxis-shaped) — carries over unchanged. |
Journey-shaped sidebar proposal for Self-Managed 8.10 docs — covers page migration map, ~45 new page briefs, rollout sequencing, and competitor analysis (Temporal, CockroachDB, Confluent). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): add Mermaid diagrams for 8.10 deployment journey Five diagrams covering: administrator journey overview, component topology (Hub/OC/PT/Optimize), availability DR tier selection, tenancy isolation model selection, and rollout phases. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): apply IA feedback — reorder Plan, Option B tabs, rename arch diagrams - Reorder Plan section: deployment target first → database → identity (database options depend on target; identity depends on both) - Rename "Reference architectures" → "Architecture diagrams" throughout - Drop "blueprint" suffix from diagram page names - Restructure Install to Option B tab model: collapse Kubernetes/Containers/Manual sub-trees into three topic steps (Provision / Install / Configure) with [Kubernetes] [Containers] [Manual] badges showing Docusaurus groupId tab pages - Add paradigm legend before §5 sidebar tree explaining badge notation - Add paradigm badges to Tier 2 DR sub-pages, Document handling sub-pages, Migrate → Run the upgrade sub-pages - Update §6 migration tables, §7 cross-cutting patterns, §8 rollout, Appendix A/B to match restructured sidebar - Update journey-overview diagram: Plan phase shows sequential dependency order Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): restructure §2 Baseline into 5 sequential numbered steps - Remove "Separating Hub and Orchestration Cluster" page — absorbed into Install Hub brief under 4. Install Camunda - Dissolve "Install" and "Common configuration" wrapper sections - New step order: 1. Provision infrastructure → 2. Provision databases → 3. Set up authentication → 4. Install Camunda → 5. Configure Camunda - Step 1 organises by paradigm tabs with cloud-provider sub-pages [AWS][GCP][Azure][OpenShift]; K8s-specific config (ingress, gateway, registry, networking) lives here not after install - Step 4 has Install Hub + Install Orchestration Cluster sub-pages (both tabbed); Register the OC in Hub moves inside Install Orchestration Cluster - Chart parameters moved from step 4 to step 5; Helm v4 requirements removed from sidebar (becomes prerequisite callout on Install Camunda page) - Update §6.3/§6.4 migration tables, Appendix A/B to match new structure - Update journey-overview diagram to show 5-step Baseline sequence Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): drop Configure Camunda step; scope Install to production essentials - Remove step 5 Configure Camunda entirely — app configuration is out of scope for the Baseline install journey - Move license key and secret management into step 4 Install Camunda as the only required non-infra config for a production install - Remove chart parameters, application-configs, custom connectors, enable additional components, document handling from Baseline scope - Update §6.3/§6.4 migration tables: out-of-scope pages marked accordingly; data-retention → Day-2 Data purge; secret-management/license-key → step 4 - Update journey-overview diagram: Baseline now 4 steps (no step 5) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): revise 8.10 IA proposal — new top-level sidebar shape Drop "Extend your deployment" as a sequential phase. Redistribute that content (Availability & DR, Tenancy & isolation, Process analytics, Database topology) into "Architecture and concepts" as standing reference material. Rename "Day-2 operations" to "Run and maintain" to avoid confusion with the Operate application. Rename "Architecture diagrams" to "Reference architectures". Rename "Install Camunda" to "Prepare installation configuration" to disambiguate from Install Hub / Install Orchestration Cluster sub-steps. New top-level shape: Quickstart → Deploy to production → Architecture and concepts → Run and maintain → Components → Migrate Update §1 executive summary, §2 core-shift rationale, §5 sidebar tree, §7 cross-cutting patterns, §8 rollout sequence, Appendix A content briefs, and Appendix B rewrite guidance to match the new structure. Update all page-by-page migration table paths (§6) accordingly. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): remove Bitnami migration from Provision databases sidebar Already covered under Migrate → Bitnami migration. No need to duplicate the entry in the baseline provisioning path. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): simplify Build your baseline sidebar for first iteration Provision infrastructure now references existing doc pages rather than proposing new ones (cloud-providers/, docker/, containers/, manual/). Remove for first iteration (out of scope until baseline infra is landed): - Provision databases (PostgreSQL / ES / Keycloak) - Set up authentication - Prepare installation configuration - Install Hub / Install Orchestration Cluster / Register the OC in Hub - Smoke test and exit criteria Production readiness checklist and Where to go next remain as placeholders. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): scope Reference architectures to existing pages only Single-region / dual-region / three-region variants removed from this section — they belong under Architecture and concepts → Availability and DR. Reference architectures now reflects what exists today at reference-architecture/ (Kubernetes, Containers, Manual / VM). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): flatten Architecture and concepts — remove Deployment concepts grouping Tenancy and isolation, Availability and DR, Process analytics, Database topology, and Authentication are now direct children of Architecture and concepts rather than nested under a "Deployment concepts" subsection. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): remove Infrastructure prerequisites and Configuration reference Both are redundant: prerequisites are covered by existing cloud provider pages and the planning section; configuration reference already exists as helm/chart-parameters. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): remove Overview page from Run and maintain Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): move DR drills out of Run and maintain — covered under Availability and DR Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): remove Onboard new teams from Run and maintain Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): promote Camunda Hub to first component, remove Components overview Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): remove Overview page from Migrate section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): remove Overview pages from Deploy to production, Quickstart Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): replace Build your baseline with Provision infrastructure Flatten Deploy to production: Provision infrastructure is now a direct child alongside Plan your deployment. Production readiness checklist promoted to direct child of Deploy to production. Where to go next removed. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): rename Provision infrastructure to Deploy your baseline Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): remove Overview from Architecture and concepts Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): align doc body with current sidebar IA - Rename Build your baseline → Deploy your baseline throughout - Remove infrastructure prerequisites and configuration reference from Architecture and concepts description - Remove DR drills and onboarding new teams from Run and maintain description - Remove orphaned Overview briefs (Architecture and concepts, Day-2) - Remove DR drills and Onboard new teams content briefs from Appendix A - Remove Choose your topology from Databases section; move RDBMS vs ES/OS brief under Plan - Rename Database topology → Databases - Rename Hub / Orchestration Cluster / Physical Tenant topology → Hub / Orchestration Cluster topology - Fix stale Extend → cross-links and DR drills page cross-link Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): rephrase as standalone proposal, remove draft-iteration language Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): remove unused diagram files, keep journey-overview Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): update journey-overview diagram to match current IA - Replace 4-phase flow (Plan/Baseline/Extend/Day-2) with current structure - Deploy to production: Plan → Deploy your baseline → Production readiness checklist - Architecture and concepts as reference (dotted arrow, non-sequential) - Run and maintain replaces Day-2 section - Remove Extend phase, DR drills, Onboard new teams - Update 8.9 vs 8.10 comparison table Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> chore(docs): remove personal and customer names from IA proposal Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
bc74712 to
c005d6a
Compare
- Fix baseline reference: "8.9 sidebar" → "Next (8.10 baseline) sidebar" - Remove unverifiable support-ticket attribution for backup discoverability - Reframe OpenShift entries as distinct targets (ROSA vs self-hosted); fix labels not merge - Reframe dual-region as dispersion-without-cross-navigation, not misfiling - Mark camunda-docs#8492 (Tier 3 RTO/RPO) as closed/held; flag as unresolved - Replace broken PR references (#5996–5999, camunda-docs#7617) with "TBD" - Flatten 4–5 level URL slugs to 2–3 levels throughout - Add per-section owner/estimate note; mark as post-approval discussion - Confirm sidebars.js navigable preview as next step once proposal approved - Split "Architecture and concepts" into Concepts (explanation) + Reference (look-up) per Diátaxis framework; propagate split across §1, §2, §5, §6, Appendix A/B, diagram - Dissolve "Deployment concepts" intermediate level; all paths now route directly - Add iterative-approach note to §9 open questions - Add Network & Security to Concepts (TLS strategy, secret management, network policy) and Reference (TLS config ref, secret key ref, NetworkPolicy ref) - Add "Choose your network & security strategy" to Plan your deployment - Add Diátaxis framework explanation to document header - Cross-reference product-hub#3388 (IRSA), #3518 (ES sizing), #3519 (NetworkPolicies) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Adopted in full. 'Architecture and concepts' is split into Concepts (Explanation) and Reference (Reference) throughout the proposal. The Diátaxis framework is now stated explicitly in the document header as the organizing principle, with the per-page test ('what single need does this page serve?') as the decision rule going forward. The one adjustment: 'Plan your deployment' stays as a how-to sub-section of Deploy to production rather than moving to Explanation, since it's action-gated (you make the decision in order to proceed with the install). The decision pages within it (Choose your resilience tier, Choose your identity strategy, etc.) are explanation-shaped, and they cross-link to the deeper Concepts pages for users who want the full trade-off depth. 'Run and maintain' name is kept over 'Operate' to avoid confusion with the Operate application — agreed this is a labeling call, not a structural one. |
Summary
docs/user journeys/8.10/8.10 deployment journey.md— a journey-shaped sidebar IA proposal for the Self-Managed 8.10 docsTest plan
sidebars.js🤖 Generated with Claude Code