Add walkthrough video for APIOps CLI usage and configuration system

Abierto
#130 1 comentario 0 reacciones 1 asignado Ver en GitHub

@azaslonov ya está trabajando en esto.

Desde el 7/7/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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

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.