Azure / Azure/apiops-cli

Add scenario-based documentation with decision flowchart

Offen
#134 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Enhancement P2
Vorherrschende Sprache
TypeScript
Sterne
26
Forks
9
Ø Merge
1 T. 3 Std.
Gemergte PRs (30 T.)
20

Beschreibung

## 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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die bestehende Dokumentationsstruktur und Navigation zu überprüfen, um zu ermitteln, wo der Szenarioleitfaden und die Landingpages hingehören. Definiere das Mermaid-Entscheidungsflussdiagramm rund um die aufgeführten Entscheidungen zu source-of-truth, branching, environment, CI/CD und change-flow. Als abgeschlossen gilt die Aufgabe, wenn das Flussdiagramm eingebettet und gepflegt wird, mindestens drei Szenarioseiten die erforderlichen Hinweise abdecken und der Dokumentationsindex auf sie verweist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
azure, github-actions
Bereich
cli, devops, documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.