Summary
Create scenario-level documentation that guides users through key decisions (branching strategy, source of truth, environment topology, etc.) via a decision flowchart, landing them in the appropriate "how-to" doc for their chosen setup.
Problem
Users come to APIOps CLI with different organizational constraints and preferences. Currently, they must read through all documentation to figure out which setup applies to them. A guided decision tree would dramatically reduce time-to-value.
Proposed Content
Decision Flowchart
A visual flowchart (mermaid diagram or similar) that walks users through key decisions:
- Source of Truth — Is APIM the source of truth, or is the Git repo?
- Branching Strategy — Trunk-based, GitFlow, environment branches, etc.
- Environment Topology — One APIM instance per environment, or multiple environments on a single instance?
- CI/CD Platform — GitHub Actions or Azure DevOps?
- Change Flow — Portal-first (extract → commit → promote) or code-first (edit → PR → publish)?
Scenario Landing Pages
Each leaf of the decision tree links to a dedicated "how-to" page covering:
- Recommended repo structure
- Configuration file setup (filters, overrides)
- CI/CD pipeline configuration
- Step-by-step walkthrough for the chosen scenario
- Common pitfalls and FAQ
Example Scenarios
- Scenario A: Git as source of truth, trunk-based development, separate APIM per environment, GitHub Actions
- Scenario B: Portal-first, feature branches, single APIM instance, Azure DevOps
- Scenario C: Hybrid (portal for discovery, Git for promotion), environment branches
Acceptance Criteria
Summary
Create scenario-level documentation that guides users through key decisions (branching strategy, source of truth, environment topology, etc.) via a decision flowchart, landing them in the appropriate "how-to" doc for their chosen setup.
Problem
Users come to APIOps CLI with different organizational constraints and preferences. Currently, they must read through all documentation to figure out which setup applies to them. A guided decision tree would dramatically reduce time-to-value.
Proposed Content
Decision Flowchart
A visual flowchart (mermaid diagram or similar) that walks users through key decisions:
Scenario Landing Pages
Each leaf of the decision tree links to a dedicated "how-to" page covering:
Example Scenarios
Acceptance Criteria