Add scenario-based documentation with decision flowchart
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Pouca atividade
- Stack de tecnologia
- azure, github-actions
- Domínio
- cli, devops, documentation
Direção de pesquisa
Comece revisando a estrutura e a navegação existentes da documentação para identificar onde o guia de cenários e as landing pages devem ficar. Defina o fluxograma de decisões do Mermaid em torno das opções listadas de source-of-truth, branching, environment, CI/CD e change-flow. Considera-se concluído quando o fluxograma estiver incorporado e for mantido, pelo menos três páginas de cenários cobrirem as orientações necessárias e o índice da documentação tiver links para elas.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
- Linguagem predominante
- TypeScript
- Estrelas
- 29
- Forks
- 10
- Merge médio
- 1d 13h
- PRs com merge (30d)
- 23
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de Azure/apiops-cli
-
type:question
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
Azure/apiops-cli#277 ·
-
type:documentation
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 94/100
Azure/apiops-cli#250 ·
-
Documentation P2
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
Azure/apiops-cli#24 · 1 comentário ·
-
type:bug
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 68/100
Azure/apiops-cli#294 ·
-
type:bug
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 55/100
Azure/apiops-cli#291 ·
Todas as issues de Azure/apiops-cli
Issues semelhantes
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
danielmiessler/LifeOS#2234 ·
-
T: Bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
-
Mend: dependency security vulnerability untriaged
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100