CMS et API

Guide de mise en œuvre du Drupal.

Utilisez les révisions Drupal, la modération du contenu et les autorisations pour séparer la génération, la révision spécialisée et la publication.

Clarifier la tâche et la décision

Ce guide transforme le guide de mise en œuvre du drupal en un flux de travail opérationnel révisable. Il relie les décisions de domaine, la propriété, les preuves et l'acceptation afin que le résultat continue de fonctionner en production.

Utilisez les révisions Drupal, la modération du contenu et les autorisations pour séparer la génération, la révision spécialisée et la publication.

Méthode pratique

  1. 1

    Types de sources d'inventaire, identifiants, champs, paramètres régionaux, propriétaires et états de publication.

  2. 2

    Choisissez le modèle de livraison parmi le volume, la latence, le contrôle éditorial et la tolérance aux pannes.

  3. 3

    Mappez l’enregistrement source à un enregistrement de version linguistique distincte avec un lien durable.

  4. 4

    Ajoutez l'authentification, l'idempotence, les nouvelles tentatives, l'invalidation du cache, la journalisation et les contrôles d'accès.

  5. 5

    Testez la publication, les modifications de source, les résultats indisponibles, la restauration, le fonctionnement du clavier et la surveillance avant la publication.

Exemple ou outil

Un type de contenu modéré affiche les champs, les rôles, les révisions, la livraison et la restauration. Dans l'outil, enregistrez également la référence, le propriétaire, la décision, les preuves, le problème en suspens et la date d'approbation. Utilisez une page ou une transaction réelle pour que l'équipe voie les dépendances, les exceptions et le travail de maintenance qui suit la publication.

Point de décisionEnregistrerCritère d'acceptation
RéférenceÉtat actuel observéSource et date d'enregistrement
DécisionOption sélectionnée et justificationRisque et public pris en compte
PreuveTester, documenter ou mesurerRévisable et spécifique à la version
ApprobationNom, rôle et dateTous les critères obligatoires sont remplis

Créer un modèle de contenu qui préserve la provenance

Créez un type de contenu en langage accessible ou une entité structurée avec une référence d'entité à la source faisant autorité. Incluez l’ID de révision source, les paramètres régionaux, le mode de langue, l’ID de résultat, l’état de révision, la version du glossaire, le niveau de risque, les approbateurs et le prochain déclencheur de révision. Utilisez des paragraphes ou des champs structurés pour les titres, les listes, les liens, les avis, les téléchargements et les informations de contact. Un seul champ de texte enrichi sans restriction rend plus difficile la validation, la réutilisation et le rendu sécurisé au niveau du champ.

Choisissez délibérément entre la relation de traduction de Drupal et une entité associée distincte. La traduction standard fonctionne lorsque la structure des champs et le cycle de vie éditorial restent équivalents. Une entité distincte est plus sûre lorsque la version accessible combine, réorganise ou explique les champs source et nécessite une modération différente. Dans les deux cas, conservez la révision source immuable pour la transformation et affichez le statut obsolète lorsque la source actuelle ne lui correspond plus.

Choix de conceptionUtiliser quandSauvegarde requise
Traduction de contenuStructure et cycle de vie restent équivalentsTraduction de révision affectée et modération testée
Entité associéeLa structure, la propriété ou l'examen diffèrentRéférence de source explicite et navigation réciproque
Mappage de paragrapheLa source contient des blocs structurés réutilisablesGénération de blocs ou d'indicateurs de bundle non pris en charge

Création séparée, révision spécialisée et publication

Configurez les états de modération du contenu tels que demandé, génération, brouillon, révision du sujet, révision de la langue, approuvé, publié, obsolète et échoué. Définissez des transitions pour les rôles dédiés et vérifiez-les avec les autorisations et les gestionnaires d'accès Drupal. Le compte d'intégration API peut créer et mettre à jour un brouillon mais ne peut pas l'approuver ou le publier. Un évaluateur sujet ne peut pas approuver sa propre génération à haut risque à moins que la politique de risque documentée ne le permette.

Activez les révisions et assurez-vous que chaque transformation, résolution de commentaire, transition de statut et rebase source crée une révision avec auteur et horodatage. Créez une vue de révision qui affiche la source et le brouillon, les différences, les avertissements, les liens et le résultat rendu. Si la source change, marquez le brouillon actif et la version publiée de manière appropriée et bloquez la publication jusqu'à ce qu'un réviseur résolve la différence.

  1. 1

    Configurez les champs d'entité, la validation, les révisions et la relation source.

  2. 2

    Créez des états de modération et des transitions spécifiques aux rôles.

  3. 3

    Générez un brouillon via un agent de file d'attente restreint.

  4. 4

    Révisions complètes du sujet et de la langue sur une révision identifiée.

  5. 5

    Publiez, indexez et conservez la piste d'audit de la source à la version.

Livrez avec une capacité de cache et une accessibilité Drupal intactes

Attachez des balises de cache pour l'entité source, la relation de révision source, l'entité de langue, les paragraphes et médias référencés, la configuration du glossaire et le moteur de rendu. Utilisez des contextes de cache pour les paramètres régionaux et toute variation d'accès légitime, mais ne faites pas dépendre les pages publiques approuvées de l'état de génération spécifique à l'utilisateur. Invalidez les pages concernées en modifiant l'entité ou en complétant la file d'attente, et gardez la dernière révision approuvée visible pendant qu'un remplacement est examiné.

Rendre la navigation linguistique sous forme de liens ordinaires via le routage Drupal et la génération d'URL prenant en compte la langue. Ajoutez des liens sources réciproques, des métadonnées dans une autre langue, des fils d'Ariane et des entrées de plan de site. Vérifiez la hiérarchie des titres, l'objectif du lien, l'ordre de mise au point, les messages d'état et l'association d'erreur de formulaire dans le thème final. Assainissez la sortie API grâce aux champs structurés autorisés et au système de rendu de Drupal. Ne marquez jamais le HTML généré comme sûr simplement parce qu'il provient d'un serveur de confiance.

  • Les balises de cache couvrent la source, la version linguistique, les composants, les médias, le glossaire et le moteur de rendu.

  • Le traitement de la file d'attente ne peut pas publier de contenu ni effacer prématurément le dernier résultat approuvé.

  • Les routes linguistiques et les liens sources fonctionnent sans JavaScript.

  • Les formats de texte et les tableaux de rendu empêchent les balisages dangereux.

  • La recherche indexe uniquement la révision approuvée et supprime les itinéraires retirés.

Prouver les autorisations, les révisions et la restauration

Les tests du noyau et fonctionnels doivent couvrir la validation sur le terrain, le contrôle d'accès, les transitions de modération, la création de révisions, la détection de sources obsolètes, les tentatives de file d'attente, l'invalidation du cache, l'accès aux routes et le rendu de chaque composant pris en charge. Testez les exécuteurs de file d'attente cron et externes Drupal, y compris les tâches qui se chevauchent et les tâches répétées. Les tests du navigateur doivent exercer le flux de travail éditorial complet avec chaque rôle et l'utilisation de l'interface uniquement au clavier.

Version avec gestion de la configuration, hooks de mise à jour, rotation des informations d'identification, tableaux de bord de file d'attente, relecture des tâches ayant échoué, minimisation des journaux, sauvegarde de la base de données et runbook de restauration. Importez la configuration dans un environnement de type production et confirmez que les ensembles, traductions, autorisations et vues existants restent intacts. L'acceptation inclut la restauration d'une révision approuvée précédente, la reconstruction des caches et des index et la confirmation que les URL publiques et les enregistrements d'audit restent corrects.

Rôles, preuves et approbation

Séparez la génération de la publication. Une réponse réussie est un brouillon et non une approbation. Stockez l'identifiant et la version de la source, les paramètres de transformation, l'identifiant du résultat, l'état de révision, l'approbateur et l'heure de publication. Lorsque la source change, marquez la version linguistique pour révision au lieu de remplacer silencieusement le contenu approuvé. Cela rend la restauration et l’audit possibles sur toutes les plateformes.

Opérations et entretien

Le travail ne s'arrête pas à la publication. Liez la version linguistique ou la configuration à sa source, surveillez les mesures de qualité et de service et définissez des déclencheurs de révision concrets. Les déclencheurs incluent les changements de source, les changements juridiques, les nouveaux besoins du public, les questions d'assistance récurrentes, les changements techniques et les incidents. Un propriétaire nommé évalue le déclencheur, ouvre une nouvelle révision si nécessaire et enregistre une nouvelle approbation.

Liste de contrôle avant publication

  • L'intégration utilise des identifiants de source durables.

  • Les informations d'identification sont stockées côté serveur et alternées.

  • Le comportement en matière de délai d'attente, de nouvelle tentative et de limite de débit est défini.

  • Les demandes répétées sont idempotentes.

  • Le contenu généré entre dans un état de révision.

  • Les modifications de source invalident ou rouvrent la version.

  • La navigation linguistique fonctionne par clavier et technologie d'assistance.

  • La surveillance couvre les échecs, les files d'attente, la latence et le contenu obsolète.

Sources de référence

  1. Documentation Simple8 API
  2. Modèles de livraison Simple8
  3. Directives pour l'accessibilité du contenu Web (WCAG) 2.2

Mettre le guide en pratique

Testez Simple8 avec un contenu représentatif et utilisez la liste de contrôle pour planifier un flux de production contrôlé.

Testez votre propre texte