Add walkthrough video for APIOps CLI usage and configuration system

Aperta
#130 1 commento 0 reazioni 1 assegnatario Vedi su GitHub

@azaslonov ci sta già lavorando.

Dal 7/7/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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:

  1. Getting Started — Installing the CLI, running apiops init, and scaffolding a repo
  2. Identity Setup — Connecting GitHub/Azure DevOps to Azure via OIDC
  3. First Extraction — Running apiops extract and reviewing the output
  4. 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
  5. Publishing — Running apiops publish and verifying changes in APIM
  6. 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
Lingua principale
TypeScript
Stelle
29
Fork
10
Merge medio
1g 14h
PR unite (30g)
22

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Azure/apiops-cli

Tutte le issue di Azure/apiops-cli

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.