CMS a API

Sprievodca implementáciou WordPress.

Zámerne si vyberte dodanie widgetu alebo API, ponechajte pôvodnú stránku kanonickú a publikujte jazykové verzie prostredníctvom revízií.

Ujasnite si úlohu a rozhodnutie

Táto príručka premení príručku implementácie wordpress 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.

Zámerne si vyberte dodanie widgetu alebo API, ponechajte pôvodnú stránku kanonickú a publikujte jazykové verzie prostredníctvom revízií.

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

Pracovný postup Gutenberg mapuje zdrojové stránky, stavy recenzií, kľúče vyrovnávacej pamäte a jazykovú navigáciu. 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á

Vyberte si widget, doplnok alebo doručenie API na strane servera

Miniaplikáciu použite, keď záleží na rýchlosti nasadenia, zdrojové stránky už majú trvalé identifikátory a je prijateľná závislosť na strane klienta. Použite doplnok WordPress, keď editori potrebujú generovanie a kontrolu v administračnom rozhraní. Doručovanie API na strane servera použite v prípade, že jazykové verzie musia byť indexované, uložené vo vyrovnávacej pamäti, zahrnuté do informačných kanálov a vykreslené aj vtedy, keď nie je k dispozícii JavaScript. Veľkí vydavatelia často kombinujú doplnok pre pracovný postup s vykresľovaním na strane servera na doručenie.

Zdokumentujte výber na základe redakčnej kontroly, výkonu, dostupnosti, vyhľadávania, chybového správania, toku údajov a vlastníctva údržby. Pôvodná stránka zostáva smerodajným zdrojom. Jazyková verzia dostane svoj vlastný príspevok alebo štruktúrovaný záznam, stabilnú adresu URL, stav recenzie a odkaz na revíziu zdroja. Vyhnite sa ukladaniu alternatívneho obsahu iba do vlastného poľa alebo vyrovnávacej pamäte prehliadača bez verzie, pretože recenzenti ho nemôžu spoľahlivo schváliť, obnoviť ani auditovať.

VzorNajlepšie sedíPrimárna kontrola
WidgetRýchle pridanie na kontrolovanú stránkuDostupný núdzový stav a stav zlyhania
Pracovný postup pluginuEditory pracujú výhradne v WordPressRoly, nonces, schopnosti a revízie
API na strane serveraIndexované, do vyrovnávacej pamäte, odolné stránkyFronta, zrušenie platnosti vyrovnávacej pamäte a operácie nasadenia

Modelovanie zdrojových vzťahov a redakčných stavov

Vytvorte typ príspevku jazykovej verzie alebo použite viacjazyčnú štruktúru, ktorá podporuje explicitné vzťahy so zdrojovými kódmi. Uložiť ID zdrojového príspevku, ID revízie zdroja, cieľové miestne nastavenie, jazykový režim, ID výsledku, verziu slovníka, stav recenzie, schvaľovateľov, publikovanú revíziu a spúšťač kontroly. Ak je to možné, ponechajte transformovanú štruktúru blokov, aby nadpisy, zoznamy, odkazy, tabuľky a upozornenia zostali sémantické, a nie zlúčené do jedného poľa HTML.

Definujte stavy pre vyžiadané, generovanie, koncept, preskúmanie predmetu, jazykovú recenziu, schválené, zverejnené, zastarané a neúspešné. Mapujte každý prechod na funkciu WordPress, nielen na viditeľné tlačidlo. Generátor môže vytvoriť koncept, ale nemôže ho schváliť. Keď sa zdroj zmení, porovnajte jeho revíziu so schválenou revíziou zdroja a presuňte jazykovú verziu do zastaranej alebo požadovanej revízie. Nezverejňujte potichu regenerovaný výsledok.

  1. 1

    Zaregistrujte záznam jazykovej verzie a požadované metadáta s povolením na dezinfekciu a REST.

  2. 2

    Mapujte podporované Gutenbergove bloky a definujte správanie pre nepodporované bloky.

  3. 3

    Nakonfigurujte roly a povolené prechody stavu.

  4. 4

    Generovať do samostatnej revízie a prezentovať porovnanie zdrojov.

  5. 5

    Publikovať až po požadovaných schváleniach pre úroveň rizika obsahu.

Bezpečné ukladanie do vyrovnávacej pamäte a poskytovanie trvalej jazykovej navigácie

Zostavte kľúče vyrovnávacej pamäte z lokality, ID zdroja, revíziu zdroja, miestne nastavenie, jazykový režim a verziu vykresľovacieho modulu. Zrušte platnosť stránky súvisiaceho jazyka, keď sa zmení schválená revízia, zmení sa jej zdroj, zmení sa zdieľaný blok alebo sa znova zverejní relevantné pravidlo terminológie. Ak spracovanie prebieha asynchrónne, počas kontroly nového konceptu poskytnite poslednú schválenú verziu. Nikdy nenahrádzajte schválený obsah prázdnym stavom, pretože generovanie nie je k dispozícii.

Pridajte jazykové odkazy ako bežné serverom vykreslené kotvy s jasnými názvami, ako napríklad „zrozumiteľný jazyk“ a „ľahko čitateľný jazyk“. Zahrňte vzájomné odkazy na zdrojovú stránku a opravte metadáta v alternatívnom jazyku. Zachovať zameranie klávesnice po prepnutí na stránke a oznámiť zmenu trasy iba prostredníctvom normálneho názvu a nadpisu stránky. Chýbajúca verzia by mala vysvetľovať, že nie je k dispozícii, a odkazovať späť na zdroj, nie skryť ovládací prvok alebo potichu sa vrátiť späť.

  • Kľúče vyrovnávacej pamäte zahŕňajú verzie zdroja a vykresľovacieho modulu.

  • Posledná schválená stránka prežije API a výpadky frontu.

  • Jazykové odkazy fungujú bez JavaScriptu a používajú schválenú terminológiu.

  • Kanonické a alternatívne metadáta odrážajú skutočný vzťah.

  • Zmeny zdieľaného bloku a glosára spúšťajú ovplyvnené úlohy kontroly.

Otestujte celú cestu publikovania a vrátenia

Použite skúšobnú kópiu s reprezentatívnymi blokmi Gutenberg, vlastnými poľami, vloženými formulármi, opakovane použiteľnými blokmi a obmedzenými príspevkami. Generovanie testov, presadzovanie rolí, komentáre k recenziám, plánované zverejnenie, náhľad, zrušenie platnosti vyrovnávacej pamäte, aktualizácia zdroja, označovanie zastaraných, vymazanie, obnovenie a vrátenie späť. Potvrďte, že koncové body REST odmietajú neoprávnené čítanie a zápis a že úlohy na pozadí nemožno spúšťať medzi lokalitami bez platných poverení nonce alebo servera.

Pred výrobou definujte monitorovanie frontu, vlastníctvo chýb, rotáciu poverení, testovanie aktualizácie doplnkov, zálohovanie databázy a bezpečný postup deaktivácie. Prijatie vyžaduje správne vykreslenie v bežných bodoch prerušenia, navigáciu pomocou klávesnice a čítačky obrazovky, žiadny posun rozloženia oproti neskoršiemu obsahu, platné štruktúrované nadpisy, vysledovateľné schválenie a obnovenie poslednej schválenej revízie. Zaznamenajte si podporované konfigurácie WordPress, PHP, editor, viacjazyčný plugin a ukladanie do vyrovnávacej pamäte.

Ú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