Add walkthrough video for APIOps CLI usage and configuration system

Đang mở
#130 1 bình luận 0 reaction 1 người được giao Xem trên GitHub

@azaslonov đang làm issue này rồi.

Từ ngày 7/7/2026.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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
Ngôn ngữ chính
TypeScript
Star
29
Fork
10
Merge trung bình
1 ngày 14 giờ
Pull request đã merge (30 ngày)
22

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure/apiops-cli

Tất cả issue của Azure/apiops-cli

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.