CMS a API

Sprievodca implementáciou TYPO3.

Modelujte verzie v prístupnom jazyku ako riadené záznamy spojené s ich zdrojovým obsahom a schválením pracovného priestoru.

Ujasnite si úlohu a rozhodnutie

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

Modelujte verzie v prístupnom jazyku ako riadené záznamy spojené s ich zdrojovým obsahom a schválením pracovného priestoru.

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

Príklad pracovného priestoru TYPO3 pokrýva mapovanie polí, prekladové vzťahy, nasadenie a zrušenie platnosti. 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á

Modelové jazykové verzie ako riadené záznamy

Použite vyhradený záznam obsahu alebo typ stránky pre verziu v prístupnom jazyku a pripojte ho k zdroju s nemenným vzťahom. Uložiť UID zdroja, revíziu zdrojového pracovného priestoru alebo hash obsahu, cieľové miestne nastavenie, jazykový režim, ID výsledku transformácie, stav recenzie, verziu slovníka, schvaľovateľov a dátum posledného overenia. Udržujte tento vzťah oddelený od bežného vzťahu prekladu miestneho nastavenia TYPO3, keď verzia zmení štruktúru alebo hustotu informácií, a nie iba jazyk.

Mapujte štruktúrované zdrojové polia zámerne. Zachovať nadpisy, odseky, zoznamy, odkazy, tabuľky, upozornenia, súbory na prevzatie a bloky kontaktov ako sémantické prvky. Definujte bezpečnú rezervu pre každý nepodporovaný prvok obsahu: ponechajte ho s upozornením recenzenta, nahraďte ho schváleným súhrnným komponentom alebo zablokujte generovanie. Nikdy nepúšťajte neznámy prvok potichu. Odkazy na súbory a odkazy si uchovávajú svoje identifikátory, takže validácia môže zistiť zmenené alebo odstránené závislosti.

Záznamové poleÚčelPožadované správanie
source_uidSpája verziu a zdrojNemenný vzťah s kontrolou povolení
source_revisionDetekuje zmeny zdrojaOznačí schválenú verziu na kontrolu, ak sa líši
review_stateOvláda pracovný tokPrechod je obmedzený rolou backendu
result_idPodporuje sledovateľnosťUložené s nastaveniami a časom požiadavky

Používajte pracovné priestory na generovanie, kontrolu a schvaľovanie

Vytvorte vygenerovaný výsledok v kontrolovanom pracovnom priestore, nikdy nie priamo v živom pracovnom priestore. Generačná rola môže požadovať a aktualizovať koncepty. Kontrolór predmetu potvrdzuje podmienky, čísla, dátumy, zodpovednosti a prepojenia. Jazykový kontrolór skontroluje zvolený režim a vykreslenú cestu. Vydavateľ overí vyriešené zistenia a presunie schválenú revíziu cez fázu zavedeného pracovného priestoru. Presadzujte tieto možnosti v oprávneniach koncového servera a logike prechodu na strane servera.

Nakonfigurujte upozornenia fázy s URL záznamu, revíziou zdroja, úrovňou rizika, požadovanou rolou a dátumom splatnosti. Recenzenti potrebujú zmysluplný rozdiel, ktorý odlišuje zmeny obsahu od šumu metadát TYPO3. Ak je zdroj upravovaný počas otvorenia recenzie, označte verziu, ktorá je neaktuálna a požiadajte tím, aby si vybral medzi úpravou konceptu alebo dokončením výslovne zaznamenanej výnimky. Systém musí zabrániť tomu, aby sa zastaraný súhlas dostal do živého vysielania.

  1. 1

    Vytvorte alebo identifikujte zdrojový záznam a zachyťte jeho revíziu pracovného priestoru.

  2. 2

    Vygenerujte štruktúrovanú verziu do priradeného pracovného priestoru.

  3. 3

    Dokončite overenie predmetu, jazyka a odkazu na vykreslenom náhľade.

  4. 4

    Vyriešte zistenia a potvrďte, že revízia zdroja je stále aktuálna.

  5. 5

    Zverejnite schválený záznam a ponechajte si úplnú históriu pracovného priestoru.

Nasaďte a zrušte platnosť bez straty schváleného obsahu

Vytvorte vylepšenia trasy a metadáta stránky, ktoré každej verzii poskytnú stabilnú a čitateľnú adresu URL. Publikovanie recipročných jazykových odkazov a kanonických vzťahov v značkách vykreslených serverom. Verziu zahrňte do vyhľadávania na stránkach a do XML sitemap až po schválení. Explicitne nakonfigurujte obmedzenia prístupu a overte, či verejná jazyková stránka nezdedí neúmyselné obmedzenie zdrojovej stránky alebo nevystaví chránený zdrojový obsah.

Ak sa zmení schválená verzia, zdroj, referenčný súbor, prvok zdieľaného obsahu, šablóna vykresľovania alebo slovník, zrušte platnosť správnych vyrovnávacích pamätí frontendu. Používajte značky vyrovnávacej pamäte, ktoré obsahujú identifikátory zdroja aj verzie. Počas generovania alebo kontroly pokračujte v poskytovaní posledného schváleného záznamu. Neúspešná požiadavka vytvorí viditeľnú backendovú úlohu a prevádzkovú udalosť, ale nevymaže platnú verejnú stránku ani ju nenahradí konceptom.

  • Každá verejná verzia má stabilnú cestu a recipročný zdrojový odkaz.

  • Vyhľadávanie a mapa stránok obsahujú iba schválené záznamy.

  • Značky vyrovnávacej pamäte pokrývajú zdroj, verziu, zdieľané prvky, súbory a renderer.

  • Chránené zdroje nemôžu uniknúť prostredníctvom vytvorených verejných záznamov.

  • Počas zlyhaní a kontroly zostáva k dispozícii posledný schválený záznam.

Prevádzkujte rozšírenie prostredníctvom aktualizácií TYPO3

Otestujte rozšírenie v porovnaní s podporovanými verziami dlhodobej podpory TYPO3, verziami PHP, databázou, viacjazyčnou konfiguráciou, pracovnými priestormi, plánovačom, rozšírením vyhľadávania a vrstvou vyrovnávacej pamäte. Automatizované integračné testy by mali zahŕňať kontroly koncových povolení, háky DataHandler, pretrvávanie vzťahov, prechody pracovného priestoru, zrušenie platnosti vyrovnávacej pamäte, zlyhanie API a detekciu zastaraných zdrojov. Testy prehliadača pokrývajú prevádzku klávesnice na zadnej strane a navigáciu na prednej strane v reprezentatívnych šírkach.

Pred vydaním úlohy plánovača dokumentov, monitorovanie frontu, rotácia poverení, uchovávanie protokolov, zálohovanie a obnova, migrácia schém a deaktivácia bezpečných rozšírení. Najprv vykonajte aktualizácie na produkčnej kópii a pred vytvorením nových overte staré schválené záznamy. Prijatie zahŕňa úspešné vrátenie kódu rozšírenia a migrácie databázy, pričom publikovaný obsah je stále dostupný a jeho história auditu je nedotknutá.

Ú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