Azure / Azure/apiops-cli

Migration guide from APIOps Toolkit to APIOps CLI

Aberta
#133 1 comentário 0 reações 0 responsáveis Ver no GitHub
Enhancement P2
Linguagem predominante
TypeScript
Estrelas
26
Forks
9
Merge médio
1d 3h
PRs com merge (30d)
20

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Use as seções de conteúdo propostas como a lista de verificação inicial, começando pelo conceito e pelo mapeamento de artefatos de Toolkit-to-CLI e, em seguida, revisando a configuração e as etapas de CI/CD e migração. Inclua o prompt de configuração assistido pelo Copilot de #120, os novos recursos e a solução de problemas; considera-se concluído quando o guia fornece aos clientes um caminho de migração completo e acionável.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
github-actions
Domínio
cli, devops, documentation
Tipo de issue
Documentação
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.