Azure / Azure/apiops-cli

Add scenario-based documentation with decision flowchart

未关闭
#134 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Enhancement P2
主要语言
TypeScript
星标
26
派生
9
平均合并
1 天 3 小时
30 天内合并 PR
20

描述

## 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:

1. **Source of Truth** — Is APIM the source of truth, or is the Git repo?
2. **Branching Strategy** — Trunk-based, GitFlow, environment branches, etc.
3. **Environment Topology** — One APIM instance per environment, or multiple environments on a single instance?
4. **CI/CD Platform** — GitHub Actions or Azure DevOps?
5. **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

贡献指南

打开贡献指南

调研方向

Start by reviewing the existing documentation structure and navigation to identify where the scenario guide and landing pages belong. Define the Mermaid decision flowchart around the listed source-of-truth, branching, environment, CI/CD, and change-flow choices. Done means the flowchart is embedded and maintained, at least three scenario pages cover the required guidance, and the documentation index links to them.

由索引模型根据 Issue 内容生成。

评估

技术栈
azure, github-actions
领域
cli, devops, documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
冷清
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。