Azure / Azure/apiops-cli

Migration guide from APIOps Toolkit to APIOps CLI

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

描述

## Summary

Create documentation (and/or a guided walkthrough) that helps customers migrate from the existing [APIOps Toolkit](https://github.com/Azure/apiops) to APIOps CLI.

## Problem

Customers currently using APIOps Toolkit need a clear path to adopt APIOps CLI. Without a migration guide, they face uncertainty about:
- How their existing extracted artifacts map to the new CLI's format
- How to recreate their CI/CD pipelines
- How to migrate their configuration (filters, overrides)
- What new capabilities they gain (e.g., Copilot-assisted configuration setup per #120)

## Proposed Content

### 1. Conceptual Mapping
- Side-by-side comparison of Toolkit vs CLI concepts (extractor → `apiops extract`, publisher → `apiops publish`, etc.)
- Differences in artifact format and directory structure

### 2. Step-by-Step Migration
- How to initialize a new repo with `apiops init`
- How to migrate existing extracted artifacts (or re-extract from scratch)
- How to convert Toolkit configuration files to CLI configuration format
- How to update CI/CD pipelines (GitHub Actions / Azure DevOps)

### 3. Leveraging New Features
- Using the interactive Copilot-assisted configuration prompt (#120) to generate new configuration files from migrated artifacts
- New capabilities not available in Toolkit (incremental publish, etc.)

### 4. FAQ / Troubleshooting
- Common migration pitfalls
- Breaking changes between Toolkit and CLI

## Related

- #120 — Interactive configuration prompt (relevant to migration step where users set up new config files)

贡献指南

打开贡献指南

调研方向

使用提议的内容部分作为初始检查清单,先从 Toolkit-to-CLI 概念和工件映射开始,然后审查配置、CI/CD 和迁移步骤。包括 #120 中由 Copilot 协助的配置提示、新功能和故障排除;完成意味着指南为客户提供完整且可执行的迁移路径。

由索引模型根据 Issue 内容生成。

评估

技术栈
github-actions
领域
cli, devops, documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
冷清
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

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