CMS ir API

WordPress įgyvendinimo vadovas.

Sąmoningai pasirinkite valdiklį arba API pristatymą, palikite pradinį puslapį kanoninį ir skelbkite kalbų versijas taisydami.

Išsiaiškinkite užduotį ir sprendimą

Šis vadovas paverčia wordpress diegimo vadovą peržiūrima darbo eiga. Jis sujungia domeno sprendimus, nuosavybės teisę, įrodymus ir priėmimą, kad rezultatas ir toliau veiktų gamyboje.

Sąmoningai pasirinkite valdiklį arba API pristatymą, palikite pradinį puslapį kanoninį ir skelbkite kalbų versijas taisydami.

Praktinė eiga

  1. 1

    Atsargų šaltinio tipai, identifikatoriai, laukai, lokalės, savininkai ir publikavimo būsenos.

  2. 2

    Pasirinkite pristatymo modelį iš apimties, delsos, redakcinės kontrolės ir klaidų tolerancijos.

  3. 3

    Susiekite šaltinio įrašą su atskiru kalbos versijos įrašu su patvariu ryšiu.

  4. 4

    Pridėkite autentifikavimo, idempotencijos, pakartotinio bandymo, talpyklos negaliojimo, registravimo ir prieigos valdiklius.

  5. 5

    Bandomasis leidinys, šaltinio pakeitimai, nepasiekiami rezultatai, atšaukimas, klaviatūros veikimas ir stebėjimas prieš išleidžiant.

Pavyzdys arba priemonė

„Gutenberg“ darbo eiga atvaizduoja šaltinio puslapius, peržiūros būsenas, talpyklos klavišus ir kalbos naršymą. Įrankyje taip pat įrašykite pradinę padėtį, savininką, sprendimą, įrodymus, atvirą problemą ir patvirtinimo datą. Naudokite tikrą puslapį arba operaciją, kad komanda matytų priklausomybes, išimtis ir priežiūros darbus po išleidimo.

Sprendimo taškasĮrašasPriėmimo kriterijus
Bazinė linijaStebėta dabartinė būklėĮrašymo šaltinis ir data
SprendimasPasirinktas variantas ir pagrindimasAtsižvelgta į riziką ir auditoriją
ĮrodymaiIšbandykite, dokumentuokite arba išmatuokiteGalima peržiūrėti ir atsižvelgiant į versiją
PatvirtinimasVardas, vaidmuo ir dataAtitiko visi privalomi kriterijai

Pasirinkite valdiklį, papildinį arba serverio API pristatymą

Naudokite valdiklį, kai svarbu diegimo greitis, šaltinio puslapiai jau turi patvarius identifikatorius ir priimtina kliento priklausomybė. Naudokite WordPress papildinį, kai redaktorius reikia generuoti ir peržiūrėti administravimo sąsajoje. Naudokite serverio API pristatymą, kai kalbos versijos turi būti indeksuojamos, talpykloje, įtrauktos į sklaidos kanalus ir pateikiamos net tada, kai „JavaScript“ nepasiekiama. Didieji leidėjai dažnai derina darbo eigos papildinį su serverio pateikimu.

Dokumentuokite pasirinkimą atsižvelgiant į redakcinę kontrolę, našumą, prieinamumą, paiešką, gedimų elgesį, duomenų srautą ir priežiūros nuosavybės teisę. Originalus puslapis išlieka autoritetingu šaltiniu. Kalbos versija gauna savo įrašą arba struktūrinį įrašą, stabilų URL, peržiūros būseną ir šaltinio taisymo nuorodą. Saugokite alternatyvų turinį tik neversijuojamame tinkintame lauke arba naršyklės talpykloje, nes tikrintojai negali jo patikimai patvirtinti, atkurti ar patikrinti.

ŠablonasGeriausiai tinkaPirminis valdymas
ValdiklisGreitas papildymas kontroliuojamoje svetainėjePrieinama atsarginė ir gedimo būsena
Papildinio darbo eigaRedaktoriai visiškai veikia WordPressVaidmenys, niekai, galimybės ir peržiūros
Serverio APIIndeksuoti, talpykloje talpinami, atsparūs puslapiaiEilių, talpyklos negaliojimo ir diegimo operacijos

Modeliuokite šaltinio ryšius ir redakcines būsenas

Sukurkite kalbos versijos įrašo tipą arba naudokite daugiakalbę struktūrą, kuri palaiko aiškius šaltinio ryšius. Išsaugokite šaltinio įrašo ID, šaltinio taisymo ID, tikslinę lokalę, kalbos režimą, rezultato ID, žodyno versiją, peržiūros būseną, patvirtinėjus, paskelbtą taisymą ir peržiūros aktyviklį. Jei įmanoma, išsaugokite transformuotą bloko struktūrą, kad antraštės, sąrašai, nuorodos, lentelės ir pranešimai liktų semantiški, o ne sujungti į vieną HTML lauką.

Apibrėžkite užklausos, generavimo, juodraščio, temos peržiūros, kalbos peržiūros, patvirtinto, paskelbto, pasenusio ir nepavykusio būsenas. Susiekite kiekvieną perėjimą į WordPress funkciją, o ne tik matomą mygtuką. Generatorius gali sukurti juodraštį, bet negali jo patvirtinti. Pasikeitus šaltiniui, palyginkite jo versiją su patvirtinta šaltinio versija ir perkelkite kalbos versiją į pasenusią arba reikalinga peržiūra. Neskelbkite atkurto rezultato tyliai.

  1. 1

    Užregistruokite kalbos versijos įrašą ir būtinus metaduomenis su valymo ir REST leidimais.

  2. 2

    Žemėlapyje palaikomi Gutenbergo blokai ir apibrėžiamas nepalaikomų blokų elgesys.

  3. 3

    Konfigūruokite vaidmenis ir leidžiamus būsenos perėjimus.

  4. 4

    Sugeneruokite atskirą versiją ir pateikite šaltinio palyginimą.

  5. 5

    Paskelbti tik gavus būtinus turinio rizikos lygio patvirtinimus.

Saugiai saugokite talpyklą ir užtikrinkite patvarią kalbos navigaciją

Sukurkite talpyklos raktus iš svetainės, šaltinio įrašo ID, šaltinio versijos, lokalės, kalbos režimo ir pateikimo versijos. Panaikinkite susijusios kalbos puslapį, kai pasikeičia patvirtinta versija, pasikeičia šaltinis, pasikeičia bendrinamas blokas arba iš naujo paskelbiama atitinkama terminų taisyklė. Jei apdorojimas vyksta asinchroniškai, pateikite paskutinę patvirtintą versiją, kol bus peržiūrimas naujas juodraštis. Niekada nepakeiskite patvirtinto turinio tuščia būsena, nes generavimas nepasiekiamas.

Pridėkite kalbų nuorodas kaip įprastus serverio pateiktus inkarus su aiškiais pavadinimais, pvz., „aiški kalba“ ir „lengvai skaitoma informacija“. Įtraukite abipuses nuorodas į šaltinio puslapį ir pataisykite metaduomenis kita kalba. Išsaugokite klaviatūros fokusavimą po perjungimo puslapyje ir praneškite apie maršruto pakeitimą tik įprastu puslapio pavadinimu ir antrašte. Trūkstanti versija turėtų paaiškinti, kad ji nepasiekiama, ir susieti atgal į šaltinį, o ne paslėpti valdiklį ar tyliai grįžti atgal.

  • Talpyklos raktai apima šaltinio ir atvaizdavimo priemonės versijas.

  • Paskutinis patvirtintas puslapis išgyvena API ir eilės nutrūkimus.

  • Kalbos nuorodos veikia be JavaScript ir naudoja patvirtintą terminiją.

  • Kanoniniai ir alternatyvūs metaduomenys atspindi tikrąjį ryšį.

  • Bendrinamo bloko ir žodyno pakeitimai suaktyvina paveiktas peržiūros užduotis.

Išbandykite visą paskelbimo ir atšaukimo kelią

Naudokite sustojimo kopiją su tipiniais Gutenbergo blokais, pasirinktiniais laukais, įterptomis formomis, daugkartinio naudojimo blokais ir ribotais įrašais. Bandomasis generavimas, vaidmenų vykdymas, komentarų peržiūra, suplanuotas paskelbimas, peržiūra, talpyklos panaikinimas, šaltinio atnaujinimas, pasenusio žymėjimo, ištrynimo, atkūrimo ir atšaukimo kūrimas. Patvirtinkite, kad REST galiniai taškai atmeta neteisėtą skaitymą ir rašymą ir kad foninės užduotys negali būti suaktyvintos įvairiose svetainėse be galiojančių nonce arba serverio kredencialų.

Prieš pradėdami gaminti, apibrėžkite eilių stebėjimą, klaidų nuosavybę, kredencialų kaitaliojimą, papildinio atnaujinimo testavimą, duomenų bazės atsarginę kopiją ir saugaus išjungimo procedūrą. Norint priimti, reikalingas teisingas atvaizdavimas įprastose pertraukos taškuose, klaviatūros ir ekrano skaitytuvo naršymas, nekeičiamas vėlyvojo turinio išdėstymas, galiojančios struktūrinės antraštės, atsekamas patvirtinimas ir atkurta paskutinė patvirtinta versija. Įrašykite palaikomas WordPress, PHP, redaktoriaus, daugiakalbio papildinio ir talpyklos konfigūracijas.

Vaidmenys, įrodymai ir patvirtinimas

Laikykite generavimą atskirai nuo publikavimo. Sėkmingas atsakymas yra juodraštis, o ne patvirtinimas. Išsaugokite šaltinio identifikatorių ir versiją, transformacijos nustatymus, rezultato identifikatorių, peržiūros būseną, tvirtintoją ir paskelbimo laiką. Pasikeitus šaltiniui, pažymėkite kalbos versiją, kad būtų galima peržiūrėti, o ne tyliai pakeiskite patvirtintą turinį. Tai leidžia atkurti ir atlikti auditą visose platformose.

Operacijos ir priežiūra

Darbas nesibaigia publikavimu. Susiekite kalbos versiją arba konfigūraciją su šaltiniu, stebėkite kokybės ir paslaugų priemones ir nustatykite konkrečius peržiūros veiksnius. Trigeriai apima šaltinio pakeitimus, teisinius pakeitimus, naujus auditorijos poreikius, pasikartojančius palaikymo klausimus, techninius pakeitimus ir incidentus. Įvardytas savininkas įvertina aktyviklį, prireikus atidaro naują versiją ir įrašo atnaujintą patvirtinimą.

Skelbimo kontrolinis sąrašas

  • Integruojant naudojami patvarūs šaltinio identifikatoriai.

  • Kredencialai saugomi serverio pusėje ir pasukami.

  • Apibrėžiamas skirtasis laikas, bandymas pakartotinai ir greičio ribojimo elgesys.

  • Pakartotiniai prašymai yra idempotenti.

  • Sugeneruotas turinys pereina į peržiūros būseną.

  • Šaltinio pakeitimai anuliuoja arba iš naujo atidaro versiją.

  • Kalbos navigacija veikia naudojant klaviatūrą ir pagalbines technologijas.

  • Stebėjimas apima gedimus, eiles, delsą ir pasenusį turinį.

Patikimi šaltiniai

  1. Simple8 API dokumentacija
  2. Simple8 pristatymo modeliai
  3. Žiniatinklio turinio prieinamumo gairės (WCAG) 2.2

Pritaikykite vadovą praktiškai

Išbandykite Simple8 su reprezentatyviu turiniu ir naudokite kontrolinį sąrašą, kad planuotumėte kontroliuojamą gamybos darbo eigą.

Išbandykite savo tekstą