Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Add scenario-based documentation with decision flowchart

Aberta
#134 1 comentário 0 reações 0 responsáveis Ver no GitHub

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

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
Linguagem predominante
TypeScript
Estrelas
29
Forks
10
Merge médio
1d 13h
PRs com merge (30d)
23

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de Azure/apiops-cli

Todas as issues de Azure/apiops-cli

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.