CMS un API

WordPress ieviešanas rokasgrāmata.

Izvēlieties logrīku vai API piegādi apzināti, saglabājiet sākotnējo lapu kā kanonisku un publicējiet valodu versijas, izmantojot labojumus.

Noskaidrojiet uzdevumu un lēmumu

Šī rokasgrāmata pārvērš wordpress ieviešanas rokasgrāmatu par pārskatāmu darbības darbplūsmu. Tas savieno domēna lēmumus, īpašumtiesības, pierādījumus un pieņemšanu, lai rezultāts turpinātu darboties ražošanā.

Izvēlieties logrīku vai API piegādi apzināti, saglabājiet sākotnējo lapu kā kanonisku un publicējiet valodu versijas, izmantojot labojumus.

Praktiskā darba gaita

  1. 1

    Krājumu avotu veidi, identifikatori, lauki, lokalizācijas, īpašnieki un publikācijas stāvokļi.

  2. 2

    Izvēlieties piegādes modeli no skaļuma, latentuma, redakcionālās kontroles un kļūdu pielaides.

  3. 3

    Kartējiet avota ierakstu ar atsevišķu valodas versijas ierakstu ar izturīgu saiti.

  4. 4

    Pievienojiet autentifikāciju, idempotenci, atkārtotu mēģinājumu, kešatmiņas nederīgumu, reģistrēšanu un piekļuves vadīklas.

  5. 5

    Testa publikācija, avota izmaiņas, nepieejami rezultāti, atcelšana, tastatūras darbība un uzraudzība pirms izlaišanas.

Piemērs vai rīks

Gūtenberga darbplūsma kartē avota lapas, pārskata stāvokļus, kešatmiņas taustiņus un valodu navigāciju. Rīkā ierakstiet arī sākotnējo stāvokli, īpašnieku, lēmumu, pierādījumus, atklāto jautājumu un apstiprināšanas datumu. Izmantojiet īstu lapu vai darījumu, lai komanda redzētu atkarības, izņēmumus un uzturēšanas darbus pēc izlaišanas.

Lēmuma punktsIerakstsPieņemšanas kritērijs
PamatlīnijaNovērots pašreizējais stāvoklisAvots un ierakstīšanas datums
LēmumsIzvēlētais variants un pamatojumsApsvērts risks un auditorija
PierādījumiPārbaudi, dokumentē vai mēraPārskatāms un konkrētai versijai
ApstiprināšanaVārds, loma un datumsVisi obligātie kritēriji ir izpildīti

Izvēlieties logrīku, spraudni vai API piegādi servera pusē

Izmantojiet logrīku, ja izvietošanas ātrumam ir nozīme, avota lapām jau ir noturīgi identifikatori un ir pieņemama klienta puses atkarība. Izmantojiet spraudni WordPress, kad redaktoriem ir nepieciešama ģenerēšana un pārskatīšana administrācijas saskarnē. Izmantojiet servera puses API piegādi, ja valodu versijas ir jāindeksē, jāiekļauj kešatmiņā, jāiekļauj plūsmās un jārenderē pat tad, ja JavaScript nav pieejams. Lielie izdevēji bieži apvieno darbplūsmas spraudni ar servera puses renderēšanu piegādei.

Dokumentējiet izvēli attiecībā pret redakcionālo kontroli, veiktspēju, pieejamību, meklēšanu, kļūmēm, datu plūsmu un uzturēšanas īpašumtiesībām. Sākotnējā lapa joprojām ir autoritatīvs avots. Valodas versijai ir savs ieraksts vai strukturēts ieraksts, stabils URL, pārskatīšanas statuss un avota pārskatīšanas saite. Neglabājiet alternatīvu saturu tikai neversijā pielāgotā laukā vai pārlūkprogrammas kešatmiņā, jo pārbaudītāji nevar to droši apstiprināt, atjaunot vai pārbaudīt.

RakstsVislabāk piemērotsPrimārā kontrole
LogrīksĀtrs papildinājums kontrolētai vietneiPieejams atkāpšanās un atteices stāvoklis
Spraudņa darbplūsmaRedaktori pilnībā strādā WordPressLomas, nonces, iespējas un pārskatīšana
Servera puses APIIndeksētas, kešatmiņā ievietojamas, elastīgas lapasRindas, kešatmiņas anulēšanas un izvietošanas darbības

Modelējiet avotu attiecības un redakcionālos stāvokļus

Izveidojiet valodas versijas ziņas veidu vai izmantojiet daudzvalodu struktūru, kas atbalsta skaidras avota attiecības. Saglabājiet avota ziņas ID, avota pārskatīšanas ID, mērķa lokalizāciju, valodas režīmu, rezultāta ID, glosārija versiju, pārskatīšanas statusu, apstiprinātājus, publicēto versiju un pārskatīšanas aktivizētāju. Ja iespējams, saglabājiet pārveidoto bloku struktūru, lai virsraksti, saraksti, saites, tabulas un paziņojumi paliktu semantiski, nevis saplacināti vienā HTML laukā.

Definējiet statusus pieprasītajam, ģenerējamajam, melnrakstam, priekšmeta pārskatīšanai, valodas pārskatīšanai, apstiprinātajam, publicētajam, novecojušai un neizdevusies. Kartē katru pāreju uz WordPress iespēju, nevis tikai redzamu pogu. Ģenerators var izveidot melnrakstu, bet nevar to apstiprināt. Kad avots mainās, salīdziniet tā versiju ar apstiprināto avota versiju un pārvietojiet valodas versiju uz novecojušu vai nepieciešama pārskatīšana. Nepublicējiet reģenerētu rezultātu klusībā.

  1. 1

    Reģistrējiet valodas versijas ierakstu un nepieciešamos metadatus ar sanitārijas un REST atļaujām.

  2. 2

    Kartē atbalstītos Gūtenberga blokus un definējiet neatbalstīto bloku darbību.

  3. 3

    Konfigurējiet lomas un atļautās statusa pārejas.

  4. 4

    Izveidojiet atsevišķu pārskatīšanu un iesniedziet avotu salīdzinājumu.

  5. 5

    Publicējiet tikai pēc nepieciešamajiem satura riska līmeņa apstiprinājumiem.

Droši saglabājiet kešatmiņu un nodrošiniet ilgstošu valodas navigāciju

Veidojiet kešatmiņas atslēgas no vietnes, avota ziņas ID, avota pārskatīšanas, lokalizācijas, valodas režīma un renderētāja versijas. Nederīgu saistītās valodas lapu, kad mainās tās apstiprinātais pārskatījums, mainās tās avots, mainās koplietots bloks vai tiek atkārtoti publicēta atbilstoša terminoloģijas kārtula. Ja apstrāde notiek asinhroni, jauno melnrakstu pārskatīšanas laikā sniedziet pēdējo apstiprināto versiju. Nekad neaizstājiet apstiprināto saturu ar tukšu statusu, jo ģenerēšana nav pieejama.

Pievienojiet valodu saites kā parastus servera atveidotus enkurus ar skaidriem nosaukumiem, piemēram, “skaidra valoda” un “vieglā valoda”. Iekļaujiet abpusējas saites uz avota lapu un labojiet alternatīvās valodas metadatus. Saglabājiet tastatūras fokusu pēc pārslēgšanās lapā un paziņojiet par maršruta maiņu, tikai izmantojot parasto lapas nosaukumu un virsrakstu. Trūkstošajai versijai ir jāpaskaidro, ka tā nav pieejama, un jāsaista atpakaļ uz avotu, nevis jāslēpj vadīkla vai klusi jāatgriežas.

  • Kešatmiņas atslēgas ietver avota un renderētāja versijas.

  • Pēdējā apstiprinātā lapa pārdzīvo API un rindu pārtraukumus.

  • Valodu saites darbojas bez JavaScript un izmanto apstiprinātu terminoloģiju.

  • Kanoniskie un alternatīvie metadati atspoguļo faktiskās attiecības.

  • Koplietojamo bloku un glosāriju izmaiņas aktivizē ietekmētos pārskatīšanas uzdevumus.

Pārbaudiet pilnu publicēšanas un atcelšanas ceļu

Izmantojiet pakāpenisku kopiju ar reprezentatīviem Gūtenberga blokiem, pielāgotiem laukiem, iegultām veidlapām, atkārtoti lietojamiem blokiem un ierobežotām ziņām. Pārbaudes ģenerēšana, lomu izpilde, komentāru pārskatīšana, plānotā publicēšana, priekšskatījums, kešatmiņas nederīgums, avota atjaunināšana, novecojušas atzīmes, dzēšana, atjaunošana un atcelšana. Apstipriniet, ka REST galapunkti noraida nesankcionētu lasīšanu un rakstīšanu un ka fona darbus nevar aktivizēt starpvietnē bez derīgiem nonce vai servera akreditācijas datiem.

Pirms ražošanas definējiet rindu uzraudzību, kļūdu īpašumtiesības, akreditācijas datu rotāciju, spraudņa atjaunināšanas testēšanu, datu bāzes dublēšanu un drošas atspējošanas procedūru. Lai to pieņemtu, ir nepieciešama pareiza renderēšana parastajos pārtraukuma punktos, tastatūras un ekrāna lasītāja navigācija, izkārtojuma maiņa no vēlīnā satura, derīgi strukturēti virsraksti, izsekojams apstiprinājums un pēdējās apstiprinātās versijas atjaunošana. Ierakstiet atbalstītās WordPress, PHP, redaktora, daudzvalodu spraudņa un kešatmiņas konfigurācijas.

Lomas, pierādījumi un apstiprinājums

Saglabājiet ģenerēšanu atsevišķi no publikācijas. Veiksmīga atbilde ir melnraksts, nevis apstiprinājums. Saglabājiet avota identifikatoru un versiju, transformācijas iestatījumus, rezultāta identifikatoru, pārskatīšanas stāvokli, apstiprinātāju un publicēšanas laiku. Kad avots mainās, atzīmējiet valodas versiju pārskatīšanai, nevis klusi nomainiet apstiprināto saturu. Tas padara iespējamu atcelšanu un auditu visās platformās.

Darbības un apkope

Darbs nebeidzas ar publicēšanu. Saistiet valodas versiju vai konfigurāciju ar tās avotu, uzraugiet kvalitātes un pakalpojumu pasākumus un definējiet konkrētus pārskatīšanas aktivizētājus. Aktivizētāji ietver avota izmaiņas, juridiskās izmaiņas, jaunas auditorijas vajadzības, periodiskus atbalsta jautājumus, tehniskas izmaiņas un incidentus. Nosaukts īpašnieks novērtē aktivizētāju, vajadzības gadījumā atver jaunu versiju un reģistrē atjaunoto apstiprinājumu.

Publicēšanas kontrolsaraksts

  • Integrācija izmanto noturīgus avota identifikatorus.

  • Akreditācijas dati tiek saglabāti servera pusē un pagriezti.

  • Noildze, atkārtots mēģinājums un ātruma ierobežojuma darbība ir definēta.

  • Atkārtoti pieprasījumi ir idempotenti.

  • Ģenerētais saturs nonāk pārskatīšanas stāvoklī.

  • Avota izmaiņas padara versiju nederīgu vai atkārtoti atver versiju.

  • Valodu navigācija darbojas, izmantojot tastatūru un palīgtehnoloģijas.

  • Uzraudzība attiecas uz kļūmēm, rindām, latentumu un novecojušu saturu.

Autoritatīvi avoti

  1. Simple8 API dokumentācija
  2. Simple8 piegādes modeļi
  3. Tīmekļa satura pieejamības vadlīnijas (WCAG) 2.2

Izmantojiet rokasgrāmatu praksē

Pārbaudiet Simple8 ar reprezentatīvu saturu un izmantojiet kontrolsarakstu, lai plānotu kontrolētu ražošanas darbplūsmu.

Pārbaudi savu tekstu