Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Add scenario-based documentation with decision flowchart

未关闭
#134 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

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

调研方向

首先检查现有的文档结构和导航,以确定场景指南和 landing pages 应放置的位置。围绕列出的 source-of-truth、branching、environment、CI/CD 和 change-flow 选项,定义 Mermaid 决策流程图。完成标准是:流程图已嵌入并得到维护,至少三个场景页面涵盖所需指南,并且文档索引链接到这些页面。

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

描述

Enhancement P2

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
主要语言
TypeScript
星标
29
派生
10
平均合并
1 天 13 小时
30 天内合并 PR
23

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Azure/apiops-cli 的其他 Issue

查看 Azure/apiops-cli 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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