Add walkthrough video for APIOps CLI usage and configuration system

Offen

#130 erstellt am 09.6.2026 1 Kommentar 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

@azaslonov arbeitet bereits daran.

Seit 07.7.2026.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Beschreibung

Enhancement P2

Summary

Create and embed a walkthrough video in the documentation that demonstrates how to use APIOps CLI end-to-end, with particular focus on the configuration system.

Proposed Content

The video should cover:

Getting Started — Installing the CLI, running apiops init, and scaffolding a repo
Identity Setup — Connecting GitHub/Azure DevOps to Azure via OIDC
First Extraction — Running apiops extract and reviewing the output
Configuration Deep-Dive
- Filter configuration (include/exclude APIs, resources)
- Publishing override configuration (per-environment overrides)
- Placeholder/token syntax for secrets ({#[TOKEN_NAME]#})
- Environment-specific configuration files
Publishing — Running apiops publish and verifying changes in APIM
CI/CD Integration — How the scaffolded GitHub Actions / Azure DevOps pipelines work

Acceptance Criteria

Video is recorded and published (YouTube or similar)
Video is embedded/linked in the documentation site
Documentation page includes timestamps or chapter links for easy navigation
README or docs index links to the video

Vorherrschende Sprache: TypeScript
Sterne: 29
Forks: 10
Ø Merge: 1 T. 14 Std.
Gemergte PRs (30 T.): 22

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Azure/apiops-cli

Docs example says products are auto-included transitively, but they aren't extracted with `products: []` Offen

type:question

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100

Azure/apiops-cli#277 · Erstellt am 10.9.2026
[Doc Drift] README extract flags table missing `--remove-stale` Offen

type:documentation

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 94/100

Azure/apiops-cli#250 · Erstellt am 31.8.2026
Create prompt file for end-to-end example for users trying apiops for the first time Offen

Documentation P2

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100

Azure/apiops-cli#24 · 1 Kommentar · Erstellt am 29.4.2026
Transitive Dependencies and namedValues issues Offen

type:bug

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 55/100

Azure/apiops-cli#291 · Erstellt am 18.9.2026
`extract` reports extraction errors / exits with code 1 for APIs using `set-body template="liquid"` with `{{ }}` expressions Offen

type:bug

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 58/100

Azure/apiops-cli#276 · Erstellt am 10.9.2026

Alle Issues in Azure/apiops-cli