CMS i API

Vodič za implementaciju WordPress.

Namjerno odaberite isporuku widgeta ili API, zadržite izvornu stranicu kanonskom i objavite jezične verzije kroz revizije.

Pojasnite zadatak i odluku

Ovaj vodič pretvara vodič za implementaciju wordpress-a u pregledni radni tijek. Povezuje odluke o domeni, vlasništvo, dokaze i prihvaćanje tako da rezultat nastavlja raditi u proizvodnji.

Namjerno odaberite isporuku widgeta ili API, zadržite izvornu stranicu kanonskom i objavite jezične verzije kroz revizije.

Praktični postupak

  1. 1

    Vrste izvora inventara, identifikatori, polja, lokalizacije, vlasnici i stanja publikacije.

  2. 2

    Odaberite uzorak isporuke između volumena, latencije, uredničke kontrole i tolerancije kvarova.

  3. 3

    Mapirajte izvorni zapis u zasebni zapis jezične verzije s trajnom vezom.

  4. 4

    Dodajte autentifikaciju, idempotenciju, ponovni pokušaj, poništavanje predmemorije, bilježenje i kontrole pristupa.

  5. 5

    Probno objavljivanje, promjene izvora, nedostupni rezultati, vraćanje, rad tipkovnice i praćenje prije izdavanja.

Primjer ili alat

Gutenbergov tijek rada mapira izvorne stranice, stanja pregleda, ključeve predmemorije i jezičnu navigaciju. U alat također zabilježite početnu vrijednost, vlasnika, odluku, dokaze, otvoreni problem i datum odobrenja. Koristite pravu stranicu ili transakciju kako bi tim vidio ovisnosti, iznimke i rad na održavanju koji slijedi nakon izdavanja.

Točka odlukeSnimitiKriterij prihvatljivosti
Osnovna linijaPromatrano trenutno stanjeIzvor i datum snimanja
OdlukaOdabrana opcija i obrazloženjeRizik i publika uzeti u obzir
DokazTestirajte, dokumentirajte ili izmjeriteMože se pregledati i ovisi o verziji
OdobrenjeIme, uloga i datumZadovoljeni svi obvezni kriteriji

Odaberite widget, dodatak ili isporuku API na strani poslužitelja

Upotrijebite widget kada je brzina postavljanja važna, izvorne stranice već imaju trajne identifikatore, a ovisnost na strani klijenta je prihvatljiva. Koristite dodatak WordPress kada urednici trebaju generiranje i pregled unutar administrativnog sučelja. Koristite API isporuku na strani poslužitelja kada jezične verzije moraju biti indeksirane, predmemorirane, uključene u feedove i prikazane čak i kada JavaScript nije dostupan. Veliki izdavači često kombiniraju dodatak za tijek rada s prikazivanjem na strani poslužitelja za isporuku.

Dokumentirajte izbor u odnosu na uredničku kontrolu, izvedbu, pristupačnost, pretraživanje, ponašanje pri neuspjehu, protok podataka i vlasništvo nad održavanjem. Izvorna stranica ostaje mjerodavan izvor. Jezična verzija dobiva vlastitu objavu ili strukturirani zapis, stabilan URL, status pregleda i vezu na izvornu reviziju. Izbjegavajte pohranjivanje alternativnog sadržaja samo u neverzionirano prilagođeno polje ili predmemoriju preglednika jer ga recenzenti ne mogu pouzdano odobriti, vratiti ili revidirati.

UzorakNajbolje odgovaraPrimarna kontrola
WidgetBrzo dodavanje kontroliranom mjestuDostupno rezervno stanje i stanje neuspjeha
Tijek rada dodatkaUrednici rade u potpunosti u WordPressUloge, nonce, sposobnosti i revizije
API na strani poslužiteljaIndeksirane, otporne stranice koje se mogu predmemoriratiRed čekanja, poništenje predmemorije i operacije implementacije

Modelirajte izvorne odnose i urednička stanja

Stvorite vrstu posta jezične verzije ili upotrijebite višejezičnu strukturu koja podržava eksplicitne izvorne odnose. ID izvorne objave pohrane, ID izvorne revizije, ciljni jezik, način rada jezika, ID rezultata, verzija pojmovnika, status pregleda, odobravatelji, objavljena revizija i okidač pregleda. Zadržite transformiranu strukturu blokova gdje je to moguće tako da naslovi, popisi, poveznice, tablice i obavijesti ostanu semantični umjesto da budu spljošteni u jedno HTML polje.

Definirajte statuse za traženo, generiranje, nacrt, predmetni pregled, jezični pregled, odobreno, objavljeno, zastarjelo i neuspjelo. Preslikajte svaki prijelaz na mogućnost WordPress, a ne samo vidljivi gumb. Generator može stvoriti nacrt, ali ga ne može odobriti. Kada se izvor promijeni, usporedite njegovu reviziju s odobrenom izvornom revizijom i premjestite jezičnu verziju na zastarjelu ili je potreban pregled. Ne objavljujte u tišini regenerirani rezultat.

  1. 1

    Registrirajte zapis jezične verzije i potrebne metapodatke s dopuštenjima za čišćenje i REST.

  2. 2

    Mapirajte podržane Gutenbergove blokove i definirajte ponašanje nepodržanih blokova.

  3. 3

    Konfigurirajte uloge i dopuštene prijelaze statusa.

  4. 4

    Generirajte u zasebnu reviziju i predstavite izvornu usporedbu.

  5. 5

    Objavite samo nakon potrebnih odobrenja za razinu rizika sadržaja.

Sigurno spremite u predmemoriju i pružite trajnu jezičnu navigaciju

Izgradite ključeve predmemorije iz web-mjesta, izvornog ID-a posta, izvorne revizije, jezika, jezičnog načina i verzije renderera. Poništite povezanu jezičnu stranicu kada se promijeni njezina odobrena revizija, izvor, promjena dijeljenog bloka ili se ponovno objavi relevantno terminološko pravilo. Ako se obrada odvija asinkrono, poslužite posljednju odobrenu verziju dok se nova skica pregledava. Nikada nemojte zamijeniti odobreni sadržaj praznim stanjem jer generiranje nije dostupno.

Dodajte jezične veze kao obična sidra prikazana na poslužitelju s jasnim nazivima kao što su "jasan jezik" i "lako čitljiv jezik". Uključite uzajamne veze na izvornu stranicu i ispravne metapodatke na drugom jeziku. Sačuvajte fokus tipkovnice nakon promjene unutar stranice i najavite promjenu rute samo kroz uobičajeni naslov i naslov stranice. Verzija koja nedostaje treba objasniti da je nedostupna i povezati se s izvorom, a ne skrivati ​​kontrolu ili se tiho vraćati natrag.

  • Ključevi predmemorije uključuju izvorne verzije i verzije renderera.

  • Posljednja odobrena stranica preživljava API i prekide čekanja.

  • Jezične veze rade bez JavaScripta i koriste odobrenu terminologiju.

  • Kanonski i alternativni metapodaci odražavaju stvarni odnos.

  • Promjene dijeljenog bloka i pojmovnika pokreću zahvaćene zadatke pregleda.

Testirajte puni put objavljivanja i vraćanja

Upotrijebite probnu kopiju s reprezentativnim Gutenbergovim blokovima, prilagođenim poljima, ugrađenim obrascima, blokovima za višekratnu upotrebu i ograničenim postovima. Generiranje testa, provedba uloga, komentari pregleda, planirano objavljivanje, pregled, poništavanje predmemorije, ažuriranje izvora, staro označavanje, brisanje, vraćanje i vraćanje. Potvrdite da krajnje točke REST-a odbijaju neovlaštena čitanja i pisanja i da se pozadinski poslovi ne mogu pokrenuti s druge stranice bez valjanih jednokratnih ili poslužiteljskih vjerodajnica.

Prije proizvodnje definirajte nadzor reda čekanja, vlasništvo pogreške, rotaciju vjerodajnica, testiranje ažuriranja dodataka, sigurnosno kopiranje baze podataka i proceduru sigurnog onemogućavanja. Prihvaćanje zahtijeva ispravno prikazivanje na uobičajenim prijelomnim točkama, navigaciju tipkovnicom i čitačem zaslona, ​​bez pomicanja izgleda kasnog sadržaja, važeće strukturirane naslove, sljedivo odobrenje i vraćanje posljednje odobrene revizije. Snimite podržane konfiguracije WordPress, PHP, uređivača, višejezičnog dodatka i predmemoriranja.

Uloge, dokazi i odobrenje

Generiranje odvojite od objavljivanja. Uspješan odgovor je nacrt, a ne odobrenje. Pohranite izvorni identifikator i verziju, postavke transformacije, identifikator rezultata, stanje pregleda, odobravatelja i vrijeme objave. Kada se izvor promijeni, označite jezičnu verziju za pregled umjesto tihe zamjene odobrenog sadržaja. To omogućuje vraćanje i reviziju na više platformi.

Operacije i održavanje

Rad ne završava objavljivanjem. Povežite jezičnu verziju ili konfiguraciju s izvorom, nadzirite mjere kvalitete i usluge i definirajte konkretne okidače pregleda. Okidači uključuju promjene izvora, pravne promjene, nove potrebe publike, pitanja podrške koja se ponavljaju, tehničke promjene i incidente. Imenovani vlasnik procjenjuje okidač, otvara novu reviziju po potrebi i bilježi obnovljeno odobrenje.

Kontrolni popis za objavu

  • Integracija koristi trajne identifikatore izvora.

  • Vjerodajnice se pohranjuju na strani poslužitelja i rotiraju.

  • Definirano je vremensko ograničenje, ponovni pokušaj i ponašanje ograničenja brzine.

  • Ponovljeni zahtjevi su idempotentni.

  • Generirani sadržaj ulazi u stanje pregleda.

  • Promjene izvora poništavaju ili ponovno otvaraju verziju.

  • Jezična navigacija radi pomoću tipkovnice i pomoćne tehnologije.

  • Praćenje pokriva kvarove, redove čekanja, latenciju i zastarjeli sadržaj.

Mjerodavni izvori

  1. Simple8 API dokumentacija
  2. Simple8 uzorci isporuke
  3. Smjernice za pristupačnost web sadržaja (WCAG) 2.2

Provedite vodič u praksi

Testirajte Simple8 s reprezentativnim sadržajem i koristite kontrolni popis za planiranje kontroliranog proizvodnog tijeka rada.

Testirajte vlastiti tekst