mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
e47328c4d8
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
152 lines
7.2 KiB
Plaintext
152 lines
7.2 KiB
Plaintext
---
|
|
title: "Migrar desde otra plataforma"
|
|
description: "Convierte la documentación de cualquier plataforma en páginas, navegación, componentes, referencias de API, recursos y redirecciones de Mintlify."
|
|
keywords: ["migración manual de documentación", "migración de Markdown", "migración de MDX", "docs.json"]
|
|
---
|
|
|
|
import MigrationLaunchChecklist from "/snippets/es/migration-launch-checklist.mdx";
|
|
|
|
Utiliza una migración manual cuando tu plataforma actual no esté en la lista de plataformas soportadas, tu sitio sea privado o necesites control total sobre la estructura resultante.
|
|
|
|
<div id="collect-your-source-content">
|
|
## Reúne tu contenido fuente
|
|
</div>
|
|
|
|
Exporta o copia todo el contenido antes de convertirlo.
|
|
|
|
1. Archivos Markdown o MDX de tu repositorio fuente
|
|
2. Una exportación nativa en Markdown o HTML desde tu plataforma actual
|
|
3. Contenido obtenido a través de la API de tu plataforma actual
|
|
4. HTML renderizado desde tu sitio publicado
|
|
5. Copia y conversión manuales
|
|
|
|
Mantén tu exportación original sin cambios. Realiza el trabajo de conversión en una copia para poder comparar o reiniciar tu migración.
|
|
|
|
Crea un inventario que contenga, para cada página, su identificador fuente, título, URL publicada, ruta de destino, tipo de contenido, versión, idioma y estado de migración. Incluye las páginas no publicadas que deban seguir estando disponibles.
|
|
|
|
<div id="create-your-mintlify-project">
|
|
## Crea tu proyecto de Mintlify
|
|
</div>
|
|
|
|
Un proyecto típico de Mintlify incluye:
|
|
|
|
- Un archivo `docs.json` para la configuración del sitio y la navegación
|
|
- Archivos Markdown o MDX para las páginas que no se generan a partir de una especificación de API
|
|
- Imágenes y archivos descargables que quieras alojar desde tu repositorio
|
|
- Opcionalmente, especificaciones OpenAPI o AsyncAPI o esquemas GraphQL para la documentación de API generada
|
|
|
|
Consulta [Páginas](/es/organize/pages) para conocer el frontmatter compatible y el comportamiento de los archivos.
|
|
|
|
<div id="design-your-navigation">
|
|
## Diseña tu navegación
|
|
</div>
|
|
|
|
Puedes reproducir fielmente tu estructura de navegación actual o usar la migración como una oportunidad para mejorar cómo los usuarios encuentran el contenido.
|
|
|
|
Utiliza una [estructura de navegación](/es/organize/navigation) adecuada. La siguiente tabla muestra patrones de navegación habituales para sitios alojados en Mintlify.
|
|
|
|
| Modelo de contenido | Elementos de navegación de Mintlify |
|
|
| --- | --- |
|
|
| Un conjunto de documentación | Grupos y páginas |
|
|
| Productos distintos | Productos |
|
|
| Áreas de contenido principales | Pestañas o anclas |
|
|
| Versiones mantenidas | Versiones |
|
|
| Documentación traducida | Idiomas |
|
|
| Resumen del grupo | Un grupo con una página `root` |
|
|
|
|
Añade cada ruta de página a `docs.json` a menos que quieras ocultar la página. Una [página oculta](/es/organize/hidden-pages) sigue siendo accesible por URL, pero se excluye por defecto de la búsqueda del sitio, los sitemaps, la indexación en buscadores y el contexto de IA.
|
|
|
|
<div id="convert-your-content">
|
|
## Convierte tu contenido
|
|
</div>
|
|
|
|
El Markdown simple suele necesitar poca conversión. Sustituye la sintaxis específica de la plataforma por componentes de Mintlify.
|
|
|
|
| Patrón fuente | Función de Mintlify |
|
|
| --- | --- |
|
|
| Bloque de nota, tip, advertencia o peligro | [Callout](/es/components/callouts) |
|
|
| Sección plegable | [Accordion](/es/components/accordions) |
|
|
| Instrucciones alternativas | [Tabs](/es/components/tabs) |
|
|
| Varios ejemplos de código | [Code group](/es/components/code-groups) |
|
|
| Tarjetas de recursos enlazados | [Cards](/es/components/cards) |
|
|
| Procedimiento secuencial | [Steps](/es/components/steps) |
|
|
| Contenido reutilizado | [Snippet reutilizable](/es/create/reusable-snippets) |
|
|
| Interfaz interactiva o específica de la aplicación | [Componente de React](/es/customize/react-components) |
|
|
|
|
Busca en tus archivos convertidos directivas de la plataforma fuente, importaciones, variables de plantilla, HTML sin procesar e includes sin resolver. Estos patrones a menudo se renderizan como texto o hacen fallar la compilación de MDX.
|
|
|
|
<div id="migrate-api-documentation">
|
|
## Migrar documentación de API
|
|
</div>
|
|
|
|
Localiza la especificación OpenAPI o AsyncAPI original o el esquema GraphQL cuando exista alguno. Añade el archivo fuente a tu repositorio de Mintlify y sigue la guía de configuración correspondiente.
|
|
|
|
- [Configuración de OpenAPI](/es/api-playground/openapi-setup)
|
|
- [Configuración de AsyncAPI](/es/api-playground/asyncapi-setup)
|
|
- [Configuración de GraphQL](/es/api-playground/graphql-setup)
|
|
|
|
Si tu plataforma fuente almacenaba las descripciones de endpoints fuera de la especificación, fusiona el contenido útil en la especificación o colócalo en guías adyacentes. Compara el orden de operaciones, la autenticación, las URL de servidor, los ejemplos, los esquemas y los code samples con tu sitio anterior.
|
|
|
|
Puedes generar páginas iniciales de endpoints OpenAPI con el paquete scraper de Mintlify:
|
|
|
|
```bash
|
|
npx @mintlify/scraping@latest openapi-file ./openapi.yaml -o api-reference
|
|
```
|
|
|
|
<div id="migrate-your-assets">
|
|
## Migra tus recursos
|
|
</div>
|
|
|
|
Copia las imágenes, vídeos, fuentes y archivos descargables que te pertenezcan a tu repositorio. Conserva las rutas públicas existentes cuando sea práctico para reducir los cambios de enlaces.
|
|
|
|
Revisa los siguientes patrones para identificar los recursos que necesitan migrarse.
|
|
|
|
- Destinos de imágenes y enlaces en Markdown
|
|
- Elementos HTML `<img>` y `<video>`
|
|
- Imágenes de fondo CSS
|
|
- Recursos referenciados por componentes importados
|
|
- Archivos alojados por tu antiguo proveedor de documentación
|
|
- Recursos específicos por versión e idioma
|
|
|
|
No dejes recursos requeridos en producción en el dominio de tu antiguo proveedor a menos que planees mantener ese hosting después de la migración.
|
|
|
|
<div id="preserve-urls">
|
|
## Conservar las URL
|
|
</div>
|
|
|
|
Crea una asignación desde cada URL publicada anterior a su destino. Añade una [redirección](/es/create/redirects) siempre que cambie la ruta.
|
|
|
|
Incluye los siguientes patrones en tu mapa de redirecciones.
|
|
|
|
- Páginas eliminadas o consolidadas durante la migración
|
|
- Prefijos de versión e idioma
|
|
- Prefijos de categoría o espacio
|
|
- Páginas de aterrizaje personalizadas
|
|
- Páginas de endpoint de API
|
|
- Slugs explícitos y aliases heredados
|
|
|
|
<div id="recreate-your-site-features">
|
|
## Recrea las funcionalidades de tu sitio
|
|
</div>
|
|
|
|
Las exportaciones de contenido no suelen incluir la configuración de la plataforma. Inventaría y recrea las funcionalidades que aún necesites.
|
|
|
|
- Dominio personalizado y DNS
|
|
- Autenticación y visibilidad de páginas
|
|
- Analítica y gestores de etiquetas
|
|
- Comportamiento de búsqueda
|
|
- Scripts y estilos personalizados
|
|
- Integraciones de feedback y soporte
|
|
- Changelogs
|
|
- Metadatos SEO, URLs canónicas y reglas de indexación
|
|
|
|
<div id="review-your-migration">
|
|
## Revisa tu migración
|
|
</div>
|
|
|
|
Compara tu proyecto migrado con tu inventario de contenido y luego confirma que cada página, versión e idioma previstos se resuelven.
|
|
|
|
Busca en tus archivos convertidos restos de sintaxis de la plataforma fuente: directivas, importaciones, variables de plantilla, HTML sin procesar e includes sin resolver.
|
|
|
|
<MigrationLaunchChecklist />
|