Azure / Azure/apiops-cli

Add walkthrough video for APIOps CLI usage and configuration system

未关闭
#130 1 条评论 0 个 reaction 已指派 1 人 已被 @azaslonov 认领 在 GitHub 查看
Enhancement P2
主要语言
TypeScript
星标
26
派生
9
平均合并
1 天 3 小时
30 天内合并 PR
20

描述

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

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。