CMS a API

Sprievodca implementáciou Drupal.

Použite revízie Drupal, moderovanie obsahu a povolenia na oddelenie generovania, odbornej kontroly a publikovania.

Ujasnite si úlohu a rozhodnutie

Táto príručka premení príručku implementácie drupal na prehľadný prevádzkový pracovný postup. Spája rozhodnutia o doméne, vlastníctvo, dôkazy a akceptovanie, takže výsledok naďalej funguje vo výrobe.

Použite revízie Drupal, moderovanie obsahu a povolenia na oddelenie generovania, odbornej kontroly a publikovania.

Praktický postup

  1. 1

    Typy zdrojov inventára, identifikátory, polia, miestne nastavenia, vlastníci a stavy publikácie.

  2. 2

    Vyberte si vzor doručenia z objemu, latencie, redakčnej kontroly a tolerancie zlyhania.

  3. 3

    Mapujte zdrojový záznam do samostatného záznamu jazykovej verzie s trvalým prepojením.

  4. 4

    Pridajte autentifikáciu, idempotenciu, opakovanie, zrušenie platnosti vyrovnávacej pamäte, protokolovanie a riadenie prístupu.

  5. 5

    Testovacia publikácia, zmeny zdroja, nedostupné výsledky, vrátenie späť, ovládanie klávesnice a monitorovanie pred vydaním.

Príklad alebo nástroj

Moderovaný typ obsahu zobrazuje polia, roly, revízie, doručenie a vrátenie. V nástroji tiež zaznamenajte základnú líniu, vlastníka, rozhodnutie, dôkazy, otvorený problém a dátum schválenia. Použite skutočnú stránku alebo transakciu, aby tím videl závislosti, výnimky a údržbu, ktorá nasleduje po vydaní.

Rozhodovací bodZáznamAkceptačné kritérium
Základná líniaPozorovaný aktuálny stavZdroj a dátum zaznamenania
rozhodnutieVybraná možnosť a zdôvodnenieZvážte riziko a publikum
DôkazyTestujte, dokumentujte alebo merajteKontrolovateľné a špecifické pre verziu
SchválenieMeno, rola a dátumSplnené všetky povinné kritériá

Vytvorte model obsahu, ktorý zachováva pôvod

Vytvorte typ obsahu v prístupnom jazyku alebo štruktúrovanú entitu s odkazom na entitu na dôveryhodný zdroj. Zahrňte ID revízie zdroja, miestne nastavenie, jazykový režim, ID výsledku, stav recenzie, verziu slovníka, úroveň rizika, schvaľovateľov a spúšťač ďalšej kontroly. Použite odseky alebo štruktúrované polia pre nadpisy, zoznamy, odkazy, upozornenia, súbory na prevzatie a kontaktné informácie. Jediné neobmedzené pole formátovaného textu sťažuje overenie na úrovni poľa, opätovné použitie a bezpečné vykresľovanie.

Zámerne si vyberte medzi prekladovým vzťahom Drupal a samostatnou súvisiacou entitou. Štandardný preklad funguje, keď štruktúra poľa a životný cyklus redakcie zostávajú ekvivalentné. Samostatná entita je bezpečnejšia, keď dostupná verzia kombinuje, mení poradie alebo vysvetľuje zdrojové polia a potrebuje iné moderovanie. V oboch prípadoch ponechajte revíziu zdroja nemennú pre transformáciu a zobrazte zastaraný stav, keď sa s ním aktuálny zdroj už nezhoduje.

Výber dizajnuPoužite, keďPožadované zabezpečenie
Preklad obsahuŠtruktúra a životný cyklus zostávajú rovnocennéOvplyvnený preklad revízie a testované moderovanie
Súvisiaci subjektŠtruktúra, vlastníctvo alebo recenzia sa líšiaExplicitná referencia na zdroj a recipročná navigácia
Mapovanie odsekovZdroj obsahuje opätovne použiteľné štruktúrované blokyNepodporované generovanie blokov alebo príznakov balíkov

Samostatná tvorba, odborná recenzia a publikácia

Nakonfigurujte stavy moderovania obsahu, ako sú požadované, generovanie, koncept, predmetná recenzia, jazyková kontrola, schválené, zverejnené, zastarané a neúspešné. Definujte prechody pre vyhradené roly a overte ich pomocou povolení a obslužných nástrojov Drupal. Integračný účet API môže vytvoriť a aktualizovať koncept, ale nemôže ho schváliť ani zverejniť. Kontrolór predmetu nemôže schváliť svoju vlastnú vysoko rizikovú generáciu, pokiaľ to nepovoľuje zdokumentovaná politika rizík.

Povoľte revízie a zabezpečte, aby každá transformácia, rozlíšenie komentárov, prechod stavu a rebase zdroja vytvorili revíziu s autorom a časovou pečiatkou. Vytvorte zobrazenie recenzie, ktoré zobrazuje zdroj a koncept, rozdiely, upozornenia, odkazy a vykreslený výsledok. Ak sa zdroj zmení, príslušne označte aktívny koncept a zverejnenú verziu a zablokujte publikáciu, kým recenzent nevyrieši nesúlad.

  1. 1

    Nakonfigurujte polia entity, overenie, revízie a vzťah so zdrojom.

  2. 2

    Vytvorte stavy moderovania a prechody špecifické pre rolu.

  3. 3

    Vygenerujte koncept prostredníctvom obmedzeného pracovníka frontu.

  4. 4

    Kompletné preskúmanie predmetu a jazyka na jednej identifikovanej revízii.

  5. 5

    Zverejňujte, indexujte a uchovávajte auditný záznam zdroja k vydaniu.

Dodávajte s neporušenou vyrovnávacou pamäťou a prístupnosťou Drupal

Pripojte značky vyrovnávacej pamäte pre zdrojovú entitu, vzťah revízie zdroja, entitu jazyka, odkazované odseky a médiá, konfiguráciu slovníka a vykresľovací modul. Použite kontexty vyrovnávacej pamäte pre miestne nastavenie a všetky legitímne variácie prístupu, ale nenechajte schválené verejné stránky závisieť od stavu generovania špecifického pre používateľa. Zrušte platnosť dotknutých stránok prostredníctvom zmien entity alebo dokončenia frontu a počas kontroly náhrady ponechajte poslednú schválenú revíziu viditeľnú.

Renderujte jazykovú navigáciu ako bežné odkazy prostredníctvom smerovania Drupal a generovania adresy URL podľa jazyka. Pridajte vzájomné zdrojové odkazy, metaúdaje v alternatívnom jazyku, navigáciu a položky mapy webu. Overte hierarchiu nadpisov, účel prepojenia, poradie zamerania, správy o stave a priradenie chýb formulára v konečnej téme. Dezinfikujte výstup API prostredníctvom povolených štruktúrovaných polí a systému vykresľovania Drupal. Nikdy neoznačujte vygenerovaný kód HTML ako bezpečný len preto, že pochádza z dôveryhodného servera.

  • Značky vyrovnávacej pamäte pokrývajú zdroj, jazykovú verziu, komponenty, médiá, slovník a renderer.

  • Spracovanie frontu nemôže zverejniť obsah ani predčasne vymazať posledný schválený výsledok.

  • Jazykové trasy a zdrojové odkazy fungujú bez JavaScriptu.

  • Textové formáty a vykresľovacie polia zabraňujú nebezpečnému označeniu.

  • Vyhľadávanie indexuje iba schválenú revíziu a odstraňuje vyradené trasy.

Dokážte povolenia, revízie a vrátenie späť

Testy jadra a funkčnosti by mali zahŕňať validáciu polí, riadenie prístupu, prechody moderovania, vytváranie revízií, detekciu zastaralého zdroja, opakovanie frontu, zrušenie platnosti vyrovnávacej pamäte, prístup k trase a vykresľovanie všetkých podporovaných komponentov. Otestujte Drupal cron a externé fronty, vrátane prekrývajúcich sa pracovníkov a opakovaných úloh. Testy prehliadača by mali vykonávať úplný redakčný pracovný postup s každou rolou a použitím frontendu iba s klávesnicou.

Vydanie so správou konfigurácie, aktualizačnými háčikmi, rotáciou poverení, tabuľami frontov, opakovaním neúspešných úloh, minimalizáciou protokolov, zálohovaním databázy a runbookom vrátenia. Importujte konfiguráciu do produkčného prostredia a potvrďte, že existujúce balíky, preklady, povolenia a zobrazenia zostanú nedotknuté. Prijatie zahŕňa obnovenie predchádzajúcej schválenej revízie, prebudovanie vyrovnávacích pamätí a indexov a potvrdenie, že verejné adresy URL a záznamy auditu zostávajú správne.

Úlohy, dôkazy a schválenie

Generovanie uchovávajte oddelene od publikácie. Úspešná odpoveď je návrh, nie schválenie. Uložte identifikátor a verziu zdroja, nastavenia transformácie, identifikátor výsledku, stav recenzie, schvaľovateľa a čas zverejnenia. Keď sa zdroj zmení, namiesto tichého nahradenia schváleného obsahu označte jazykovú verziu na kontrolu. To umožňuje rollback a audit naprieč platformami.

Prevádzka a údržba

Publikovaním práca nekončí. Prepojte jazykovú verziu alebo konfiguráciu s jej zdrojom, monitorujte opatrenia na kvalitu a služby a definujte konkrétne spúšťače kontroly. Spúšťače zahŕňajú zmeny zdroja, právne zmeny, nové potreby publika, opakujúce sa otázky podpory, technické zmeny a incidenty. Pomenovaný vlastník vyhodnotí spúšťač, v prípade potreby otvorí novú revíziu a zaznamená obnovené schválenie.

Kontrolný zoznam na zverejnenie

  • Integrácia využíva trvalé identifikátory zdroja.

  • Poverenia sú uložené na strane servera a rotujú sa.

  • Časový limit, opakovanie a správanie pri obmedzení rýchlosti sú definované.

  • Opakované žiadosti sú idempotentné.

  • Vygenerovaný obsah prejde do stavu kontroly.

  • Zmeny zdroja znehodnotia alebo znova otvoria verziu.

  • Jazyková navigácia funguje pomocou klávesnice a asistenčnej technológie.

  • Monitorovanie pokrýva zlyhania, fronty, latenciu a zastaraný obsah.

Odborné zdroje

  1. Simple8 Dokumentácia API
  2. Vzory dodávky Simple8
  3. Smernice o prístupnosti webového obsahu (WCAG) 2.2

Uveďte návod do praxe

Otestujte Simple8 s reprezentatívnym obsahom a použite kontrolný zoznam na plánovanie riadeného výrobného pracovného postupu.

Otestujte si svoj vlastný text