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.5 KiB
Plaintext
152 lines
7.5 KiB
Plaintext
---
|
|
title: "Migrer depuis une autre plateforme"
|
|
description: "Convertissez la documentation de toute plateforme vers les pages, la navigation, les composants, les références API, les ressources et les redirections de Mintlify."
|
|
keywords: ["migration manuelle de documentation", "migration Markdown", "migration MDX", "docs.json"]
|
|
---
|
|
|
|
import MigrationLaunchChecklist from "/snippets/fr/migration-launch-checklist.mdx";
|
|
|
|
Utilisez une migration manuelle lorsque votre plateforme actuelle ne figure pas dans les plateformes listées, que votre site est privé ou que vous avez besoin d'un contrôle complet sur la structure résultante.
|
|
|
|
<div id="collect-your-source-content">
|
|
## Rassembler votre contenu source
|
|
</div>
|
|
|
|
Exportez ou copiez tout le contenu avant de le convertir.
|
|
|
|
1. Les fichiers Markdown ou MDX de votre référentiel source
|
|
2. Un export natif Markdown ou HTML depuis votre plateforme actuelle
|
|
3. Le contenu récupéré via l'API de votre plateforme actuelle
|
|
4. Le HTML rendu depuis votre site publié
|
|
5. La copie et la conversion manuelles
|
|
|
|
Conservez votre export original inchangé. Effectuez le travail de conversion dans une copie afin de pouvoir comparer ou redémarrer votre migration.
|
|
|
|
Créez un inventaire contenant l'identifiant source, le titre, l'URL publiée, le chemin de destination, le type de contenu, la version, la langue et le statut de migration de chaque page. Incluez les pages non publiées qui doivent rester disponibles.
|
|
|
|
<div id="create-your-mintlify-project">
|
|
## Créer votre projet Mintlify
|
|
</div>
|
|
|
|
Un projet Mintlify typique comprend :
|
|
|
|
- Un fichier `docs.json` pour les paramètres du site et la navigation
|
|
- Des fichiers Markdown ou MDX pour les pages qui ne sont pas générées à partir d'une spécification d'API
|
|
- Des images et des fichiers téléchargeables que vous souhaitez héberger depuis votre référentiel
|
|
- Des spécifications OpenAPI ou AsyncAPI facultatives, ou des schémas GraphQL pour la documentation d'API générée
|
|
|
|
Voir [Pages](/fr/organize/pages) pour connaître le frontmatter pris en charge et le comportement des fichiers.
|
|
|
|
<div id="design-your-navigation">
|
|
## Concevoir votre navigation
|
|
</div>
|
|
|
|
Vous pouvez reproduire fidèlement votre structure de navigation existante ou profiter de la migration comme d'une opportunité pour améliorer la façon dont les utilisateurs trouvent le contenu.
|
|
|
|
Utilisez une [structure de navigation](/fr/organize/navigation) appropriée. Le tableau suivant montre les motifs de navigation courants pour les sites hébergés sur Mintlify.
|
|
|
|
| Modèle de contenu | Éléments de navigation Mintlify |
|
|
| --- | --- |
|
|
| Un seul ensemble de documentation | Groupes et pages |
|
|
| Produits distincts | Produits |
|
|
| Grandes zones de contenu | Onglets ou ancrages |
|
|
| Versions maintenues | Versions |
|
|
| Documentation traduite | Langues |
|
|
| Présentation de groupe | Un groupe avec une page `root` |
|
|
|
|
Ajoutez chaque chemin de page à `docs.json` sauf si vous prévoyez de masquer la page. Une [page masquée](/fr/organize/hidden-pages) reste accessible par URL, mais elle est exclue par défaut de la recherche du site, des sitemaps, de l'indexation par les moteurs de recherche et du contexte IA.
|
|
|
|
<div id="convert-your-content">
|
|
## Convertir votre contenu
|
|
</div>
|
|
|
|
Le Markdown ordinaire nécessite généralement peu de conversion. Remplacez la syntaxe spécifique à la plateforme par des composants Mintlify.
|
|
|
|
| Motif source | Fonctionnalité Mintlify |
|
|
| --- | --- |
|
|
| Bloc note, tip, warning ou danger | [Callout](/fr/components/callouts) |
|
|
| Section repliable | [Accordion](/fr/components/accordions) |
|
|
| Instructions alternatives | [Tabs](/fr/components/tabs) |
|
|
| Plusieurs exemples de code | [Code group](/fr/components/code-groups) |
|
|
| Tuiles de ressources liées | [Cards](/fr/components/cards) |
|
|
| Procédure séquentielle | [Steps](/fr/components/steps) |
|
|
| Contenu réutilisé | [Snippet réutilisable](/fr/create/reusable-snippets) |
|
|
| Interface interactive ou spécifique à une application | [Composant React](/fr/customize/react-components) |
|
|
|
|
Recherchez dans vos fichiers convertis les directives, imports, variables de templating, HTML brut et includes non résolus de la plateforme source. Ces motifs s'affichent souvent sous forme de texte ou font échouer un build MDX.
|
|
|
|
<div id="migrate-api-documentation">
|
|
## Migrer la documentation d'API
|
|
</div>
|
|
|
|
Localisez la spécification OpenAPI ou AsyncAPI originale ou le schéma GraphQL lorsqu'il en existe un. Ajoutez le fichier source à votre référentiel Mintlify et suivez le guide de configuration correspondant.
|
|
|
|
- [Configuration OpenAPI](/fr/api-playground/openapi-setup)
|
|
- [Configuration AsyncAPI](/fr/api-playground/asyncapi-setup)
|
|
- [Configuration GraphQL](/fr/api-playground/graphql-setup)
|
|
|
|
Si votre plateforme source stockait les descriptions d'endpoints en dehors de la spécification, fusionnez le contenu utile dans la spécification ou placez-le dans des guides adjacents. Comparez l'ordre des opérations, l'authentification, les URL de serveur, les exemples, les schémas et les échantillons de code avec votre ancien site.
|
|
|
|
Vous pouvez générer des pages d'endpoints OpenAPI initiales avec le package scraper Mintlify :
|
|
|
|
```bash
|
|
npx @mintlify/scraping@latest openapi-file ./openapi.yaml -o api-reference
|
|
```
|
|
|
|
<div id="migrate-your-assets">
|
|
## Migrer vos ressources
|
|
</div>
|
|
|
|
Copiez les images, vidéos, polices et fichiers téléchargeables dont vous êtes propriétaire dans votre référentiel. Préservez les chemins publics existants lorsque cela est pratique afin de réduire les changements de liens.
|
|
|
|
Passez en revue les motifs suivants pour identifier les ressources qui doivent être migrées.
|
|
|
|
- Destinations des images et des liens Markdown
|
|
- Éléments HTML `<img>` et `<video>`
|
|
- Images d'arrière-plan CSS
|
|
- Ressources référencées par des composants importés
|
|
- Fichiers hébergés par votre ancien fournisseur de documentation
|
|
- Ressources spécifiques à une version et à une langue
|
|
|
|
Ne laissez pas de ressources de production requises sur le domaine de votre ancien fournisseur, sauf si vous prévoyez de conserver cet hébergement après la migration.
|
|
|
|
<div id="preserve-urls">
|
|
## Préserver les URL
|
|
</div>
|
|
|
|
Créez un mappage de chaque ancienne URL publiée vers sa destination. Ajoutez une [redirection](/fr/create/redirects) chaque fois que le pathname change.
|
|
|
|
Incluez les motifs suivants dans votre mappage de redirection.
|
|
|
|
- Pages supprimées ou consolidées lors de la migration
|
|
- Préfixes de version et de langue
|
|
- Préfixes de catégorie ou d'espace
|
|
- Pages d'accueil personnalisées
|
|
- Pages d'endpoints d'API
|
|
- Slugs explicites et anciens alias
|
|
|
|
<div id="recreate-your-site-features">
|
|
## Recréer les fonctionnalités de votre site
|
|
</div>
|
|
|
|
Les exports de contenu n'incluent normalement pas la configuration de la plateforme. Inventoriez et recréez les fonctionnalités dont vous avez encore besoin.
|
|
|
|
- Domaine personnalisé et DNS
|
|
- Authentification et visibilité des pages
|
|
- Analytique et gestionnaires de balises
|
|
- Comportement de la recherche
|
|
- Scripts et styles personnalisés
|
|
- Intégrations de retours et de support
|
|
- Changelogs
|
|
- Métadonnées SEO, URL canoniques et règles d'indexation
|
|
|
|
<div id="review-your-migration">
|
|
## Vérifier votre migration
|
|
</div>
|
|
|
|
Comparez votre projet migré à votre inventaire de contenu, puis vérifiez que chaque page, version et langue prévue se résout.
|
|
|
|
Recherchez dans vos fichiers convertis toute syntaxe de la plateforme source résiduelle : directives, imports, variables de templating, HTML brut et includes non résolus.
|
|
|
|
<MigrationLaunchChecklist />
|