Importer et exporter un site de documentation

Déplacez votre centre d'aide existant vers un site de documentation Clevera, ou téléchargez tout le contenu d'un site sous forme de fichier zip. Les importations transfèrent les pages, les images, la structure, les traductions et les anciennes adresses ; les exportations vous permettent de récupérer votre contenu sous forme de fichiers HTML ou Markdown. Ces deux opérations sont gratuites.

Avant de commencer#

• Ouvrez votre site de documentation et accédez à Paramètres → Import & export.
• Seul le propriétaire de l'espace de travail peut importer ou exporter. Les administrateurs peuvent ouvrir l'onglet et consulter les informations, mais ses commandes sont désactivées : "Seul le propriétaire de l'espace de travail peut importer ou exporter du contenu."
• L'importation et l'exportation ne coûtent aucun crédit, quel que soit votre forfait.
• Les pages importées ne sont pas en ligne tant que vous ne les avez pas publiées, vous pouvez donc les examiner au préalable.

Importer vos documents#

1. Choisir votre plateforme#

   Sous Importer du contenu, cliquez sur la plateforme où se trouvent vos documents. Si elle n'est pas listée, choisissez Tout autre site de documentation.

   

2. Connexion#

   Choisissez comment vous connecter sous Comment se connecter, remplissez les champs et cliquez sur Vérifier la connexion. Consultez Plateformes et méthodes pour savoir ce qui est requis pour chaque option.

3. Aperçu#

   Clevera liste les sections et les pages trouvées. Décochez les pages que vous ne souhaitez pas importer. Un site volumineux peut prendre une minute : "Nous listons chaque section et page."

4. Choisir les options#

   Choisissez où les pages seront placées et quelles langues importer. Consultez Options d'importation.

5. Confirmer et démarrer#

   Vérifiez le résumé, par exemple "Nous copierons 120 pages dans une nouvelle section, “Centre d'aide”." et le Temps estimé, puis cliquez sur Démarrer l'importation.

Vous pouvez fermer la fenêtre pendant l'exécution : "Vous pouvez fermer cette fenêtre. Nous vous enverrons un e-mail lorsque l'importation sera terminée." La progression affiche Importation des pages en cours, Copie des images, Liaison des pages et Ajout de redirections, avec le nombre de Pages, Images et Échec.

Une fois terminée, vous recevrez un e-mail, "Votre importation depuis plateforme est prête", avec Voir le rapport. Examinez ensuite les pages et publiez le site.

Plateformes et méthodes#

Chaque carte de plateforme indique les méthodes prises en charge : API, Site public et Dépôt / zip.

Les méthodes#

Site public. Collez l'adresse de vos documents publics (la page d'accueil ou toute page de documentation), sous Adresse du site. Clevera lit les pages listées dans sa navigation ou son plan de site, à un rythme modéré qui respecte votre robots.txt. Seules les pages situées sous cette adresse sont lues. Les articles privés et les brouillons ne sont pas inclus.

Jeton ou clé API. Collez un jeton que vous créez sur l'autre plateforme. Chaque carte de plateforme contient les étapes et un lien vers l'endroit où le créer. Clevera ne fait que lire. Les jetons sont utilisés pendant l'importation et supprimés sous 24 heures. Vous pouvez révoquer le jeton sur l'autre plateforme une fois l'importation terminée.

Dépôt Git. Collez l'Adresse du dépôt (GitHub, GitLab ou Bitbucket). Pour un dépôt GitHub privé, ajoutez un Jeton d'accès avec un accès en lecture seule au contenu. Clevera télécharge la branche par défaut sous forme d'archive et n'exécute jamais son code.

Télécharger un zip. Téléchargez un .zip de vos documents, jusqu'à 200 Mo. Clevera lit les fichiers Markdown, MDX, JSON, YAML et les images, et ignore tout le reste. Pour Tout autre site de documentation, le zip peut contenir des fichiers .md, .mdx ou .html, et chaque dossier de premier niveau devient une section.

Notes sur les plateformes#

• Intercom n'autorise pas le partage de jetons d'accès avec d'autres applications, donc Clevera lit votre centre d'aide public.
• L'accès à l'API Zendesk nécessite un administrateur sur un forfait à partir de Team. Tout agent peut lire les articles publiés ; un administrateur Guide peut également importer des brouillons et des articles restreints.
• Help Scout vous permet de choisir Articles publiés uniquement ou Articles publiés et brouillons. Ses clés API ne peuvent pas être en lecture seule, supprimez donc la clé après l'opération.
• Les pages de référence API, recettes et pages personnalisées de ReadMe restent sur ReadMe.
• L'accès à l'API Document360 est disponible sur ses forfaits Business et Enterprise et nécessite une clé API récente.
• Notion nécessite que le propriétaire de l'espace de travail crée la connexion, avec "Lire le contenu uniquement".
• Confluence fonctionne avec les sites Confluence Cloud.
• Documents avec plusieurs versions : seule la version la plus récente est importée.

Options d'importation#

Pour la méthode Site public, cochez également "Je possède ce contenu ou j'ai le droit de le copier." avant de commencer.

Comment la structure est transférée#

• Les pages, images, sections, groupes, traductions, redirections et entrées du journal des modifications sont importés.
• Les sites de documentation ont des sections avec un niveau de groupes en dessous. Les niveaux plus profonds sont remontés d'un niveau, avec un avertissement dans le rapport.
• Les pages importées sont prêtes à être publiées ; elles seront mises en ligne lors de votre prochaine publication. Les entrées du journal des modifications importées arrivent sous forme de brouillons.
• Les images sont copiées sur le site. Une image qui ne peut pas être copiée est omise avec un avertissement, et son texte alternatif est conservé.
• Les liens entre les pages importées sont redirigés vers leurs nouvelles adresses. Les liens vers des pages qui n'ont pas été importées conservent leurs adresses d'origine.
• Les pages trouvées uniquement dans le plan du site, et non dans le menu, sont placées dans un groupe nommé "Autres pages".

Limites#

La carte indique combien d'importations il reste pour aujourd'hui et la limite de pages.

Le rapport d'importation#

Cliquez sur Voir le rapport sous Importations récentes. Le rapport affiche la section, ainsi que les totaux pour Importé, Ignoré, Échec, Images et Redirections. Filtrez les pages par Échec, Avec des avertissements ou Ignoré, et cliquez sur Ouvrir dans l'éditeur pour en corriger une.

Exemples d'avertissements :

• "Cette page était imbriquée plus profondément que ce que les sites de documentation autorisent, elle a donc été remontée d'un niveau."
• "Une image n'a pas pu être copiée, elle a donc été omise."
• "Une page avec cette adresse existe déjà ici, elle a donc été ignorée."
• "Ignoré : robots.txt ou les règles d'adresse du site nous empêchent de lire cette page."

Annuler une importation#

• Annuler l'importation s'arrête après les pages en cours de lecture. Les pages déjà importées restent, et vous pouvez les supprimer depuis le rapport.
• Annuler l'importation supprime les pages, images, redirections et entrées du journal des modifications créées par l'importation, ainsi que sa nouvelle section si elle est désormais vide.

Exporter un site#

1. Choisir un format#

   Sous Exporter vos données, choisissez le Format d'exportation : HTML (pages que vous ouvrez dans un navigateur, images dans leur propre dossier) ou Markdown (fichiers .md bruts, images dans leur propre dossier).

   

2. Demander l'exportation#

   Cliquez sur Demander l'exportation. Vous verrez le message "Exportation demandée. Nous vous enverrons un lien de téléchargement par e-mail à" votre adresse, "généralement sous 10 minutes".

3. Télécharger l'exportation#

   Ouvrez l'e-mail "Votre exportation de site est prête" et cliquez sur Télécharger l'exportation. Vous devez être connecté à Clevera. Le lien est valide pendant 7 jours ; l'exportation apparaît également sous la carte avec Télécharger jusqu'à son expiration.

Le fichier zip contient :

• Toutes les pages du site, brouillons inclus et marqués "Draft", dans toutes les langues, ainsi que les pages du site.
• Le journal des modifications, brouillons inclus.
• Les images, stockées une seule fois chacune.
• La navigation, les paramètres du site, les redirections (redirects.csv) et une liste de vidéos (videos.csv), avec un README.txt expliquant les fichiers.

Vous pouvez demander 3 exportations par site et par jour (sur une période glissante de 24 heures). Une exportation échouée ne compte pas. Seule la personne ayant demandé une exportation peut la télécharger. Lorsque le propriétaire effectue une exportation, les administrateurs reçoivent une notification indiquant qu'une exportation a été réalisée.

Vidéos#

Les vidéos ne sont pas incluses dans le fichier zip. Dans les fichiers, chaque vidéo est un lien : "Regarder / exporter cette vidéo". La carte Vidéos répertorie toutes les vidéos Clevera présentes sur les pages du site avec Exporter la vidéo, ce qui ouvre la vidéo afin que vous puissiez l'exporter dans la qualité souhaitée.

Dépannage#

Sur le même sujet#