CMS og API

Drupal implementeringsvejledning.

Brug Drupal-revisioner, indholdsmoderering og tilladelser til at adskille generering, specialistgennemgang og udgivelse.

Afklar opgave og beslutning

Denne vejledning gør drupal implementeringsvejledning til en arbejdsgang, der kan gennemgås. Det forbinder domænebeslutninger, ejerskab, beviser og accept, så resultatet fortsætter med at fungere i produktionen.

Brug Drupal-revisioner, indholdsmoderering og tilladelser til at adskille generering, specialistgennemgang og udgivelse.

Praktisk arbejdsgang

  1. 1

    Beholdningskildetyper, identifikatorer, felter, lokaliteter, ejere og udgivelsestilstande.

  2. 2

    Vælg leveringsmønsteret fra volumen, latens, redaktionel kontrol og fejltolerance.

  3. 3

    Tilknyt kildeposten til en separat sprogversionspost med holdbar kobling.

  4. 4

    Tilføj godkendelse, idempotens, forsøg igen, cache-invalidering, logning og adgangskontrol.

  5. 5

    Testpublikation, kildeændringer, utilgængelige resultater, rollback, tastaturbetjening og overvågning før udgivelse.

Eksempel eller værktøj

En modereret indholdstype viser felter, roller, revisioner, levering og tilbagerulning. I værktøjet skal du også registrere basislinje, ejer, beslutning, bevis, åbent spørgsmål og godkendelsesdato. Brug en rigtig side eller transaktion, så teamet ser afhængigheder, undtagelser og vedligeholdelsesarbejdet, der følger efter udgivelsen.

BeslutningspunktOptagAcceptkriterium
BaselineObserveret nuværende tilstandKilde og dato registreret
BeslutningValgt mulighed og begrundelseRisiko og publikum taget i betragtning
BeviserTest, dokumenter eller målGennemgåbar og versionsspecifik
GodkendelseNavn, rolle og datoAlle obligatoriske kriterier opfyldt

Opret en indholdsmodel, der bevarer herkomst

Opret en indholdstype på tilgængeligt sprog eller en struktureret enhed med en enhedsreference til den autoritative kilde. Inkluder kilderevisions-id, lokalitet, sprogtilstand, resultat-id, gennemgangstilstand, ordlisteversion, risikoniveau, godkendere og næste gennemgangstrigger. Brug afsnit eller strukturerede felter til overskrifter, lister, links, meddelelser, downloads og kontaktoplysninger. Et enkelt ubegrænset rich-text-felt gør validering, genbrug og sikker gengivelse på feltniveau sværere.

Vælg bevidst mellem Drupal's oversættelsesrelation og en separat relateret enhed. Standardoversættelse fungerer, når feltstruktur og redaktionel livscyklus forbliver ens. En separat enhed er mere sikker, når den tilgængelige version kombinerer, genbestiller eller forklarer kildefelter og har brug for anden moderering. I begge tilfælde skal du holde kilderevisionen uforanderlig for transformationen og vise forældet status, når den aktuelle kilde ikke længere matcher den.

DesignvalgBrug hvornårPåkrævet beskyttelse
Oversættelse af indholdStruktur og livscyklus forbliver ensRevisionsoversættelse påvirket og moderation testet
Beslægtet enhedStruktur, ejerskab eller anmeldelse er forskelligEksplicit kildehenvisning og gensidig navigation
AfsnitskortlægningKilden indeholder genanvendelige strukturerede blokkeIkke-understøttet bundle-blokke eller flaggenerering

Separat oprettelse, specialistgennemgang og udgivelse

Konfigurer indholdsmodereringstilstande såsom anmodet, generering, kladde, emnegennemgang, sproggennemgang, godkendt, offentliggjort, forældet og mislykket. Definer overgange for dedikerede roller, og verificer dem med Drupal-tilladelser og adgangsbehandlere. API-integrationskontoen kan oprette og opdatere et udkast, men kan ikke godkende eller offentliggøre. En faggransker kan ikke godkende deres egen højrisikogenerering, medmindre den dokumenterede risikopolitik tillader det.

Aktiver revisioner og sørg for, at hver transformation, kommentaropløsning, statusovergang og kildeomlægning opretter en revision med forfatter og tidsstempel. Byg en anmeldelsesvisning, der viser kilde og kladde, forskelle, advarsler, links og det gengivede resultat. Hvis kilden ændres, skal du markere det aktive udkast og den offentliggjorte version korrekt og blokere for offentliggørelse, indtil en korrekturlæser løser uoverensstemmelsen.

  1. 1

    Konfigurer enhedsfelter, validering, revisioner og kildeforhold.

  2. 2

    Opret moderationstilstande og rollespecifikke overgange.

  3. 3

    Generer en kladde gennem en begrænset køarbejder.

  4. 4

    Komplet emne- og sproggennemgang på én identificeret revision.

  5. 5

    Udgiv, indekser og behold revisionssporet fra kilde til udgivelse.

Lever med Drupal cache- og tilgængelighed intakt

Vedhæft cache-tags for kildeenheden, kilderevisionsforholdet, sprogentiteten, refererede afsnit og medier, ordlistekonfiguration og renderer. Brug cache-kontekster til lokalitet og enhver legitim adgangsvariation, men lad ikke godkendte offentlige sider afhænge af brugerspecifik genereringstilstand. Ugyldiggør berørte sider gennem enhedsændringer eller køfuldførelse, og hold den sidst godkendte revision synlig, mens en erstatning gennemgås.

Gengiv sprognavigation som almindelige links gennem Drupal-routing og sprogbevidst URL-generering. Tilføj gensidige kildelinks, metadata på alternativt sprog, brødkrummer og sitemapposter. Bekræft overskriftshierarki, linkformål, fokusrækkefølge, statusmeddelelser og formularfejltilknytning i det endelige tema. Rengør API-output gennem tilladte strukturerede felter og Drupal's gengivelsessystem. Markér aldrig genereret HTML som sikker, blot fordi den kom fra en betroet server.

  • Cache-tags dækker kilde, sprogversion, komponenter, medier, ordliste og renderer.

  • Købehandling kan ikke offentliggøre indhold eller rydde det sidst godkendte resultat for tidligt.

  • Sprogruter og kildelinks fungerer uden JavaScript.

  • Tekstformater og gengivelsesarrays forhindrer usikker markering.

  • Søgning indekserer kun den godkendte revision og fjerner tilbagetrukne ruter.

Bevis tilladelser, revisioner og tilbagerulning

Kernel- og funktionstests bør dække feltvalidering, adgangskontrol, modereringsovergange, oprettelse af revision, detektering af gammel kilde, genforsøg i kø, cache-invalidering, ruteadgang og gengivelse af hver understøttet komponent. Test Drupal cron og eksterne køløbere, inklusive overlappende arbejdere og gentagne job. Browsertests bør udøve den komplette redaktionelle arbejdsgang med hver rolle og kun tastaturbrug.

Frigivelse med konfigurationsstyring, opdateringshook, rotation af legitimationsoplysninger, kø-dashboards, genafspilning af mislykkede job, logminimering, databasesikkerhedskopiering og en rollback-runbook. Importer konfiguration til et produktionslignende miljø, og bekræft, at eksisterende bundter, oversættelser, tilladelser og visninger forbliver intakte. Accept inkluderer gendannelse af en tidligere godkendt revision, genopbygning af caches og indekser og bekræftelse af, at offentlige URL'er og revisionsposter forbliver korrekte.

Roller, beviser og godkendelse

Hold generation adskilt fra udgivelse. Et vellykket svar er et udkast, ikke en godkendelse. Gem kilde-id'et og -versionen, transformationsindstillinger, resultat-id'er, gennemgangstilstand, godkender og udgivelsestid. Når kilden ændres, skal du markere sprogversionen til gennemgang i stedet for lydløst at erstatte godkendt indhold. Dette gør rollback og revision mulig på tværs af platforme.

Drift og vedligeholdelse

Værket slutter ikke ved udgivelsen. Knyt sprogversionen eller konfigurationen til dens kilde, overvåg kvalitets- og servicemål, og definer konkrete gennemgangsudløsere. Triggere omfatter kildeændringer, juridiske ændringer, nye publikumsbehov, tilbagevendende supportspørgsmål, tekniske ændringer og hændelser. En navngivet ejer evaluerer udløseren, åbner en ny revision, når det er nødvendigt, og registrerer fornyet godkendelse.

Tjekliste før udgivelse

  • Integrationen bruger holdbare kildeidentifikatorer.

  • Legitimationsoplysninger gemmes på serversiden og roteres.

  • Timeout, genforsøg og hastighedsbegrænsningsadfærd er defineret.

  • Gentagne anmodninger er idempotente.

  • Genereret indhold går ind i en anmeldelsestilstand.

  • Kildeændringer ugyldiggør eller genåbner versionen.

  • Sprognavigation fungerer ved hjælp af tastatur og hjælpeteknologi.

  • Overvågning dækker fejl, køer, latens og forældet indhold.

Autoritative kilder

  1. Simple8 API dokumentation
  2. Simple8 leveringsmønstre
  3. Retningslinjer for tilgængelighed til webindhold (WCAG) 2.2

Udfør guiden i praksis

Test Simple8 med repræsentativt indhold, og brug tjeklisten til at planlægge en kontrolleret produktionsarbejdsgang.

Test din egen tekst