Add walkthrough video for APIOps CLI usage and configuration system

Open
#130 1 comment 0 reactions 1 assignee View on GitHub

@azaslonov is already working on this.

Since Jul 7, 2026.

Assessment

This issue has not been assessed yet.

Description

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
Dominant language
TypeScript
Stars
29
Forks
10
Avg merge
1d 14h
Merged PRs (30d)
22

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/apiops-cli

All issues in Azure/apiops-cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.