Add scenario-based documentation with decision flowchart
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- azure, github-actions
- 领域
- cli, devops, documentation
调研方向
首先检查现有的文档结构和导航,以确定场景指南和 landing pages 应放置的位置。围绕列出的 source-of-truth、branching、environment、CI/CD 和 change-flow 选项,定义 Mermaid 决策流程图。完成标准是:流程图已嵌入并得到维护,至少三个场景页面涵盖所需指南,并且文档索引链接到这些页面。
由索引模型根据 Issue 内容生成。
描述
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
- Decision flowchart is created and embedded in documentation
- At least 3 scenario landing pages are written
- Each scenario page includes repo structure, config setup, and CI/CD guidance
- Flowchart is maintained as a mermaid diagram (or similar) for easy updates
- Documentation index/nav links to the scenario guide prominently
- 主要语言
- TypeScript
- 星标
- 29
- 派生
- 10
- 平均合并
- 1 天 13 小时
- 30 天内合并 PR
- 23
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
Azure/apiops-cli 的其他 Issue
-
type:question
难度 2/5 1-3 小时 新手友好度 76/100
Azure/apiops-cli#277 ·
-
type:documentation
难度 1/5 1 小时以内 新手友好度 94/100
Azure/apiops-cli#250 ·
-
Documentation P2
难度 2/5 1-3 小时 新手友好度 70/100
Azure/apiops-cli#24 · 1 条评论 ·
-
type:bug
难度 3/5 1-2 天 新手友好度 68/100
Azure/apiops-cli#294 ·
-
type:bug
难度 4/5 3-5 天 新手友好度 55/100
Azure/apiops-cli#291 ·
相似的 Issue
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
danielmiessler/LifeOS#2234 ·
-
T: Bug
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 1/5 1 小时以内 新手友好度 85/100
-
Mend: dependency security vulnerability untriaged
难度 2/5 1-3 小时 新手友好度 70/100