Add scenario-based documentation with decision flowchart
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 45/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- azure, github-actions
- Lĩnh vực
- cli, devops, documentation
Hướng nghiên cứu
Bắt đầu bằng cách xem xét cấu trúc và điều hướng tài liệu hiện có để xác định vị trí của hướng dẫn kịch bản và các landing page. Xác định lưu đồ quyết định Mermaid xoay quanh các lựa chọn source-of-truth, branching, environment, CI/CD và change-flow được liệt kê. Công việc được xem là hoàn tất khi lưu đồ được nhúng và duy trì, ít nhất ba trang kịch bản bao quát hướng dẫn bắt buộc và mục lục tài liệu liên kết đến các trang đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- TypeScript
- Star
- 29
- Fork
- 10
- Merge trung bình
- 1 ngày 13 giờ
- Pull request đã merge (30 ngày)
- 23
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Azure/apiops-cli
-
type:question
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Azure/apiops-cli#277 ·
-
type:documentation
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 94/100
Azure/apiops-cli#250 ·
-
Documentation P2
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
Azure/apiops-cli#24 · 1 bình luận ·
-
type:bug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
Azure/apiops-cli#294 ·
-
type:bug
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 55/100
Azure/apiops-cli#291 ·
Tất cả issue của Azure/apiops-cli
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
vercel-labs/just-bash#464 ·
-
looksLikeSlug() is ASCII-only, so non-Latin entity slugs (e.g. Korean) skip exact match and collapse Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
TanStack/tanstack.com#1293 ·