Migration guide from APIOps Toolkit to APIOps CLI

Abierto
#133 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
github-actions
Área
cli, devops, documentation

Línea de trabajo

Usa las secciones de contenido propuestas como lista de comprobación inicial, comenzando por el concepto y la asignación de artefactos de Toolkit-to-CLI, y revisando después la configuración, CI/CD y los pasos de migración. Incluye el prompt de configuración asistido por Copilot de #120, las nuevas capacidades y la resolución de problemas; se considera terminado cuando la guía ofrece a los clientes una ruta de migración completa y aplicable.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Enhancement P2

Summary

Create documentation (and/or a guided walkthrough) that helps customers migrate from the existing APIOps Toolkit 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)
Lenguaje dominante
TypeScript
Estrellas
29
Forks
10
Merge medio
1 d 14 h
PR fusionados (30 d)
22

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Azure/apiops-cli

Todos los issues de Azure/apiops-cli

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.