Avant de commencer
- Autorisation d'exporter le contenu de groupe pertinent et les informations personnelles.
- Documentation pour l'application source, le format d'exportation et la destination prévue.
- Une destination de test séparée avec les notifications sortantes et les intégrations externes contenues.
1. Décidez ce que le paquet doit vous permettre de faire.
Écrivez le résultat souhaité avant de sélectionner un bouton d'exportation. Une copie lisible pour un membre sortant, un déplacement vers une autre application et une récupération complète du service existant nécessitent des éléments différents. Une exportation peut bien servir le premier objectif et échouer aux deux autres.
BookStack établit explicitement cette distinction : ses outils d'exportation et d'importation de contenu ne sont pas destinés à servir de sauvegarde et de restauration. Une copie lisible au format HTML ou PDF est utile, mais elle ne doit pas remplacer silencieusement l'ensemble de récupération de l'application. Exportation et importation de contenu dans BookStack.
Pour un groupe d'atelier hypothétique, l'objectif initial est modeste : un autre mainteneur autorisé peut lire le manuel d'exploitation et importer une section représentative, y compris ses diagrammes, dans une instance de test distincte.
2. Enregistrez le format et les lacunes.
Créez une matrice qui décrit ce que vous devez préserver et comment vous allez le prouver. N'inscrivez pas « complet » dans une cellule avant d'avoir vérifié la destination.
| Élément | Résultat candidat | Question à résoudre |
|---|---|---|
| Pages wiki | HTML lisible plus paquet d'importation pris en charge | Les titres, les liens et les diagrammes sont-ils conservés ? |
| Pièces jointes | Fichiers originaux et manifeste | Chaque référence importante peut-elle retrouver son fichier ? |
| Calendrier | Fichier d'échange de calendrier pris en charge | La récurrence et le fuseau horaire se comportent-ils comme prévu ? |
| Adhésion et permissions | Notes sur le mappage contrôlé des rôles | Quelles règles d'accès doivent être recréées manuellement ? |
| Récupération de l'application | Ensemble de sauvegarde spécifique à la version | Quelle configuration et quelle base de données sont encore nécessaires ? |
BookStack documente un format ZIP portable contenant des données de contenu, des pièces jointes et des images qui peuvent être réimportés dans BookStack. Cela n'établit pas la compatibilité avec un autre wiki ni la préservation de chaque paramètre au niveau du service. Formats d'exportation BookStack.
3. Donnez au paquet un point de départ humain.
Ajoutez un court fichier readme avec l'application source et sa version, la date et le fuseau horaire de l'exportation, la portée sélectionnée, le rôle de l'exportateur, la liste des fichiers et la destination prévue. Utilisez des noms de dossiers descriptifs tels que readable-content, attachments et import-package. Conservez les identifiants ailleurs ; n'écrivez que la procédure de récupération approuvée pour les mainteneurs autorisés.
Le manuel hypothétique contient une liste de contrôle d'ouverture, une page d'entretien des machines, un diagramme et un tableur lié. Son manifeste enregistre ces quatre éléments, leurs chemins relatifs et la relation entre la page et sa pièce jointe. Notez également une page restreinte comme délibérément exclue, afin qu'une absence ne soit pas plus tard confondue avec une perte accidentelle.
Une somme de contrôle peut aider à identifier un fichier inchangé lors du transfert. Elle ne prouve pas que l'exportation était complète, correctement autorisée ou lisible.
4. Inspectez un échantillon représentatif.
Ouvrez la copie lisible sans dépendre d'une session active dans l'application d'origine. Suivez un lien, inspectez une image intégrée et ouvrez la pièce jointe liée. Recherchez les références qui renvoient encore au service source. Notez quels liens sont intentionnellement externes et lesquels seraient rompus après un déplacement.
Pour les calendriers, choisissez un échantillon comprenant un événement récurrent, une exception et un événement avec un fuseau horaire pertinent. Nextcloud documente l'exportation de calendrier et les formats compatibles iCalendar pour .ics l'importation. Cela établit un chemin d'échange pris en charge, mais pas la preuve que votre cible préserve chaque fonctionnalité choisie. Importation et exportation du calendrier Nextcloud.
Consultez la documentation de votre version installée avant de suivre les libellés de l'interface ; le manuel évolutif lié peut décrire une version différente.
5. Importez dans une destination séparée et contrôlée.
Utilisez une destination de test vide ou une collection de test explicitement approuvée. Laissez le service de travail et ses données d'origine intacts. Désactivez les notifications sortantes et limitez les connexions externes avant de démarrer l'application importée ; le but est d'évaluer les données, non de renvoyer des événements historiques aux membres.
Demandez au second mainteneur de suivre le readme sans se fier à des instructions non documentées de l'exportateur. Comparez les éléments attendus avec le résultat importé. Vérifiez le diagramme, le lien vers le tableur, la structure des pages et les permissions des membres prévues. Notez tout mappage de rôles qui nécessite un travail manuel. Si un format ne dispose pas d'une fonctionnalité nécessaire, décidez s'il faut la reconstruire, choisir une autre méthode d'exportation ou conserver une archive lisible à côté du nouveau service.
6. Rendez l'échec informatif.
Si des fichiers manquent, comparez la portée de l'exportation et les permissions de l'exportateur avant de produire à plusieurs reprises des archives plus volumineuses. Si des liens sont rompus, déterminez s'ils font référence à l'ancien service ou à un fichier absent du paquet. Si l'importation crée des doublons inattendus, arrêtez et inspectez ses règles de correspondance avant d'importer à nouveau le même paquet.
Pour l'exemple d'atelier, l'acceptation signifie que le second mainteneur peut lire et modifier les pages sélectionnées, récupérer chaque fichier inclus et démontrer qu'un membre ordinaire ne peut pas accéder au matériel exclu. Notez chaque résultat et son réviseur. « L'importation est terminée » n'est qu'une observation. Conservez les différences non résolues listées à côté du paquet afin que le groupe puisse prendre une décision délibérée à leur sujet.
7. Gardez les exportations et la récupération dans leurs propres voies.
Stockez un paquet accepté dans un emplacement contrôlé indépendant du service source et convenez du moment de son actualisation. Revoyez à nouveau après des changements de formats importants, de permissions ou de versions d'application. Les fichiers d'exportation peuvent contenir du contenu privé même si la destination n'est que temporaire ; attribuez-leur donc aussi un accès et une décision de conservation.
Conservez séparément l'ensemble de récupération de l'application : la documentation de récupération de BookStack, par exemple, exige des données de base de données et de fichiers au-delà d'une exportation de document lisible. Exigences de sauvegarde et de restauration de BookStack.
Poursuivez avec la exercice de restauration pour la récupération du service, la feuille de calcul de stockage pour l'espace de travail d'exportation et la l'inventaire des services pour les dépendances. La portabilité est quelque chose à démontrer avec votre paquet, pas à supposer à partir d'une extension de fichier.
Documentation à l'appui de cette note
Utilisez la documentation de la version que vous exécutez réellement. Ces exemples sont du matériel de planification, et non un compte rendu d'un test sur un VPS Hoszen.