Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Add scenario-based documentation with decision flowchart

Abierto
#134 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
azure, github-actions

Línea de trabajo

Comienza revisando la estructura y la navegación existentes de la documentación para identificar dónde deben ubicarse la guía de escenarios y las landing pages. Define el diagrama de flujo de decisiones de Mermaid en torno a las opciones indicadas de source-of-truth, branching, environment, CI/CD y change-flow. Se considera terminado cuando el diagrama de flujo está integrado y se mantiene, al menos tres páginas de escenarios cubren la orientación requerida y el índice de documentación enlaza con ellas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
TypeScript
Estrellas
29
Forks
10
Merge medio
1 d 13 h
PR fusionados (30 d)
23

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Azure/apiops-cli

Todos los issues de Azure/apiops-cli

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.