CMS a API

Průvodce implementací WordPress.

Záměrně zvolte widget nebo doručení API, ponechte původní stránku kanonickou a publikujte jazykové verze prostřednictvím revizí.

Ujasněte si úkol a rozhodnutí

Tato příručka přemění průvodce implementací wordpress na přehledný provozní pracovní postup. Propojuje rozhodování o doméně, vlastnictví, důkazy a přijímání, takže výsledek nadále funguje v produkci.

Záměrně zvolte widget nebo doručení API, ponechte původní stránku kanonickou a publikujte jazykové verze prostřednictvím revizí.

Praktický postup

  1. 1

    Typy zdrojů inventáře, identifikátory, pole, národní prostředí, vlastníci a stavy publikace.

  2. 2

    Vyberte vzor doručení z objemu, latence, redakční kontroly a odolnosti proti selhání.

  3. 3

    Mapujte zdrojový záznam na samostatný záznam jazykové verze s trvalým propojením.

  4. 4

    Přidejte ověřování, idempotency, opakování, zneplatnění mezipaměti, protokolování a řízení přístupu.

  5. 5

    Testovací publikace, změny zdroje, nedostupné výsledky, vrácení zpět, ovládání klávesnice a monitorování před vydáním.

Příklad nebo nástroj

Pracovní postup Gutenberg mapuje zdrojové stránky, stavy recenzí, klíče mezipaměti a jazykovou navigaci. V nástroji také zaznamenejte výchozí stav, vlastníka, rozhodnutí, důkazy, otevřený problém a datum schválení. Použijte skutečnou stránku nebo transakci, aby tým viděl závislosti, výjimky a údržbu, která následuje po vydání.

Rozhodovací bodZáznamKritérium přijetí
Základní liniePozorovaný aktuální stavZdroj a datum zaznamenány
RozhodnutíVybraná možnost a zdůvodněníZváženo riziko a publikum
DůkazTestujte, dokumentujte nebo měřteKontrolovatelné a specifické pro verzi
SchváleníJméno, role a datumSplněna všechna povinná kritéria

Vyberte widget, plugin nebo doručení API na straně serveru

Použijte widget, když záleží na rychlosti nasazení, zdrojové stránky již mají trvalé identifikátory a je přijatelná závislost na straně klienta. Použijte plugin WordPress, když editoři potřebují generovat a kontrolovat v administračním rozhraní. Doručování API na straně serveru použijte, když jazykové verze musí být indexovány, ukládány do mezipaměti, zahrnuty do zdrojů a vykreslovány, i když je JavaScript nedostupný. Velcí vydavatelé často kombinují plugin pro pracovní postup s vykreslováním na straně serveru pro doručení.

Zdokumentujte výběr s ohledem na redakční kontrolu, výkon, dostupnost, vyhledávání, chybové chování, tok dat a vlastnictví údržby. Autoritativním zdrojem zůstává původní stránka. Jazyková verze dostane svůj vlastní příspěvek nebo strukturovaný záznam, stabilní URL, stav recenze a odkaz na zdrojovou revizi. Vyhněte se ukládání alternativního obsahu pouze do vlastního pole bez verze nebo mezipaměti prohlížeče, protože recenzenti jej nemohou spolehlivě schválit, obnovit ani auditovat.

VzorNejlépe sedíPrimární ovládání
WidgetRychlé přidání na kontrolovanou stránkuPřístupné nouzové a poruchové stavy
Pracovní postup pluginuEditory pracují výhradně v WordPressRole, nonces, schopnosti a revize
API na straně serveruIndexované, mezipaměti, odolné stránkyOperace fronty, zrušení platnosti mezipaměti a nasazení

Modelové zdrojové vztahy a redakční stavy

Vytvořte typ příspěvku jazykové verze nebo použijte vícejazyčnou strukturu, která podporuje explicitní zdrojové vztahy. Uložte ID příspěvku zdroje, ID revize zdroje, cílové národní prostředí, jazykový režim, ID výsledku, verzi glosáře, stav recenze, schvalovatele, publikovanou revizi a spouštěč kontroly. Pokud je to možné, ponechte transformovanou blokovou strukturu, aby nadpisy, seznamy, odkazy, tabulky a upozornění zůstaly sémantické, spíše než aby byly sloučeny do jednoho pole HTML.

Definujte stavy pro vyžádané, generování, koncept, předmětovou recenzi, jazykovou recenzi, schváleno, publikováno, zastaralé a neúspěšné. Mapujte každý přechod na funkci WordPress, nikoli pouze na viditelné tlačítko. Generátor může vytvořit koncept, ale nemůže ho schválit. Když se zdroj změní, porovnejte jeho revizi se schválenou revizí zdroje a přesuňte jazykovou verzi do zastaralé nebo požadované revize. Nepublikujte potichu regenerovaný výsledek.

  1. 1

    Zaregistrujte záznam jazykové verze a požadovaná metadata s oprávněními k čištění a REST.

  2. 2

    Mapujte podporované Gutenbergovy bloky a definujte chování pro nepodporované bloky.

  3. 3

    Nakonfigurujte role a povolené přechody stavu.

  4. 4

    Generovat do samostatné revize a prezentovat srovnání zdrojů.

  5. 5

    Publikovat pouze po požadovaných schváleních pro úroveň rizika obsahu.

Bezpečné ukládání do mezipaměti a poskytování trvalé jazykové navigace

Sestavte klíče mezipaměti z webu, ID zdrojového příspěvku, revizi zdroje, národní prostředí, jazykový režim a verzi rendereru. Zrušte platnost stránky souvisejícího jazyka, když se změní její schválená revize, změní se její zdroj, změní se sdílený blok nebo bude znovu publikováno příslušné pravidlo terminologie. Pokud zpracování probíhá asynchronně, poskytněte poslední schválenou verzi, zatímco bude nový koncept revidován. Nikdy nenahrazujte schválený obsah prázdným stavem, protože generování není k dispozici.

Přidejte jazykové odkazy jako běžné serverem vykreslené kotvy s jasnými názvy, jako je „srozumitelný jazyk“ a „snadné čtení“. Zahrňte vzájemné odkazy na zdrojovou stránku a opravte metadata v alternativním jazyce. Zachovat fokus klávesnice po přepnutí na stránce a oznámit změnu trasy pouze prostřednictvím normálního názvu a nadpisu stránky. Chybějící verze by měla vysvětlit, že je nedostupná, a odkazovat zpět na zdroj, nikoli skrývat ovládací prvek nebo v tichosti opakovat.

  • Klíče mezipaměti zahrnují verzi zdroje a vykreslovače.

  • Poslední schválená stránka přežije API a výpadky fronty.

  • Jazykové odkazy fungují bez JavaScriptu a používají schválenou terminologii.

  • Kanonická a alternativní metadata odrážejí skutečný vztah.

  • Změny ve sdílených blocích a glosář spouštějí ovlivněné úlohy revize.

Otestujte úplnou cestu publikování a vrácení

Použijte pracovní kopii s reprezentativními Gutenbergovými bloky, vlastními poli, vloženými formuláři, opakovaně použitelnými bloky a omezenými příspěvky. Generování testů, vynucení rolí, recenze komentářů, plánované publikování, náhled, zneplatnění mezipaměti, aktualizace zdroje, označení zastaralých dat, odstranění, obnovení a vrácení zpět. Potvrďte, že koncové body REST odmítají neoprávněné čtení a zápisy a že úlohy na pozadí nelze spouštět mezi weby bez platných pověření nonce nebo serveru.

Před výrobou definujte monitorování fronty, vlastnictví chyb, rotaci pověření, testování aktualizací pluginu, zálohování databáze a bezpečný postup deaktivace. Přijetí vyžaduje správné vykreslování v běžných bodech přerušení, navigaci pomocí klávesnice a čtečky obrazovky, žádný posun rozvržení od pozdního obsahu, platné strukturované nadpisy, dohledatelné schválení a obnovení poslední schválené revize. Zaznamenejte si podporované konfigurace WordPress, PHP, editor, vícejazyčný plugin a mezipaměť.

Role, důkazy a schválení

Generování uchovávejte odděleně od publikace. Úspěšná odpověď je návrh, nikoli schválení. Uložte identifikátor zdroje a verzi, nastavení transformace, identifikátor výsledku, stav recenze, schvalovatele a čas publikace. Když se zdroj změní, místo tichého nahrazování schváleného obsahu označte jazykovou verzi ke kontrole. To umožňuje rollback a audit napříč platformami.

Provoz a údržba

Publikací práce nekončí. Propojte jazykovou verzi nebo konfiguraci s jejím zdrojem, sledujte měření kvality a služeb a definujte konkrétní spouštěče kontroly. Spouštěče zahrnují změny zdroje, právní změny, nové potřeby publika, opakující se otázky podpory, technické změny a incidenty. Jmenovaný vlastník vyhodnotí spouštěč, v případě potřeby otevře novou revizi a zaznamená obnovené schválení.

Kontrolní seznam pro zveřejnění

  • Integrace využívá trvalé identifikátory zdroje.

  • Pověření se ukládají na straně serveru a střídají se.

  • Je definován časový limit, opakování a chování při omezení rychlosti.

  • Opakované žádosti jsou idempotentní.

  • Vygenerovaný obsah přejde do stavu recenze.

  • Změny zdroje zruší platnost nebo znovu otevřou verzi.

  • Jazyková navigace funguje pomocí klávesnice a asistenční technologie.

  • Monitorování pokrývá selhání, fronty, latenci a zastaralý obsah.

Odborné zdroje

  1. Simple8 Dokumentace API
  2. Vzory dodávek Simple8
  3. Pokyny pro přístupnost webového obsahu (WCAG) 2.2

Uveďte návod do praxe

Otestujte Simple8 s reprezentativním obsahem a použijte kontrolní seznam k plánování řízeného výrobního pracovního postupu.

Otestujte si svůj vlastní text