CMS ja API

WordPress rakendamise juhend.

Valige teadlikult vidin või API-edastus, hoidke originaalleht kanoonilisena ja avaldage keeleversioonid läbi versioonide.

Selgitage ülesanne ja otsus

See juhend muudab wordpress juurutamise juhendi ülevaatavaks töövooks. See ühendab domeeniotsused, omandiõiguse, tõendid ja aktsepteerimise, nii et tulemus töötab tootmises edasi.

Valige teadlikult vidin või API-edastus, hoidke originaalleht kanoonilisena ja avaldage keeleversioonid läbi versioonide.

Praktiline töövoog

  1. 1

    Varude allika tüübid, identifikaatorid, väljad, lokaadid, omanikud ja avaldamise olekud.

  2. 2

    Valige tarnemuster helitugevuse, latentsuse, toimetuse juhtimise ja tõrketaluvuse hulgast.

  3. 3

    Vastandage lähtekirje püsiva sidemega eraldi keeleversiooni kirjega.

  4. 4

    Lisage autentimine, idempotentsus, uuesti proovimine, vahemälu kehtetuks tunnistamine, logimine ja juurdepääsu juhtelemendid.

  5. 5

    Testi avaldamine, allika muudatused, kättesaamatud tulemused, tagasipööramine, klaviatuuri kasutamine ja jälgimine enne avaldamist.

Näide või tööriist

Gutenbergi töövoog kaardistab lähtelehed, ülevaate olekud, vahemälu võtmed ja keele navigeerimine. Tööriistas registreerige ka lähteseisund, omanik, otsus, tõendid, avatud probleem ja kinnitamise kuupäev. Kasutage päris lehte või tehingut, et meeskond näeks sõltuvusi, erandeid ja väljalaskmisele järgnevat hooldustööd.

OtsustuspunktSalvestusVastuvõtmise kriteerium
LähtejoonTäheldatud hetkeseisuAllikas ja salvestamise kuupäev
OtsusValitud variant ja põhjendusArvestatud on riski ja publikuga
TõendidTestige, dokumenteerige või mõõtkeÜlevaatav ja versioonipõhine
HeakskiitNimi, roll ja kuupäevKõik kohustuslikud kriteeriumid on täidetud

Valige vidin, pistikprogramm või serveripoolne API edastamine

Kasutage vidinat, kui juurutamise kiirus on oluline, lähtelehtedel on juba püsivad identifikaatorid ja kliendipoolne sõltuvus on vastuvõetav. Kasutage WordPress pistikprogrammi, kui redigeerijad vajavad haldusliideses genereerimist ja ülevaatamist. Kasutage serveripoolset API-edastust, kui keeleversioonid tuleb indekseerida, vahemällu salvestada, voogudesse kaasata ja renderdada isegi siis, kui JavaScript pole saadaval. Suured väljaandjad kombineerivad sageli töövoo jaoks mõeldud pistikprogrammi ja edastamiseks serveripoolset renderdamist.

Dokumenteerige valik toimetuse juhtimise, jõudluse, juurdepääsetavuse, otsingu, tõrkekäitumise, andmevoo ja hoolduse omandiõiguse suhtes. Algne leht jääb autoriteetseks allikaks. Keeleversioon saab oma postituse või struktureeritud kirje, stabiilse URL-i, ülevaatuse oleku ja allika versiooni lingi. Vältige alternatiivse sisu salvestamist ainult versioonita kohandatud väljale või brauseri vahemällu, kuna ülevaatajad ei saa seda usaldusväärselt kinnitada, taastada ega auditeerida.

MusterParim sobivusEsmane juhtimine
VidinKiire lisamine kontrollitud saidileJuurdepääsetav varu- ja tõrkeolek
Plugina töövoogToimetajad töötavad täielikult WordPress-sRollid, ebaolud, võimalused ja versioonid
Serveripoolne APIIndekseeritud, vahemällu salvestatavad, vastupidavad lehedJärjekorra, vahemälu kehtetuks tunnistamise ja juurutamise toimingud

Mudeli allikate seoseid ja toimetusolekuid

Looge keeleversiooni postitustüüp või kasutage mitmekeelset struktuuri, mis toetab selgesõnalisi allikasuhteid. Salvestage lähtepostituse ID, allika redaktsiooni ID, sihtlokaad, keelerežiim, tulemuse ID, sõnastiku versioon, ülevaatuse olek, heakskiitjad, avaldatud versioon ja ülevaatuse käivitaja. Võimaluse korral säilitage muudetud ploki struktuur, et pealkirjad, loendid, lingid, tabelid ja teated jääksid semantilisteks, mitte ei lamendataks üheks HTML-väljaks.

Määratlege olekud taotletud, loova, mustandi, teema ülevaatuse, keeleülevaatuse, heakskiidetud, avaldatud, aegunud ja ebaõnnestunud. Kaardistage iga üleminek WordPress-funktsiooniga, mitte ainult nähtava nupuga. Generaator võib luua mustandi, kuid ei saa seda heaks kiita. Kui allikas muutub, võrrelge selle versiooni kinnitatud allika versiooniga ja teisaldage keeleversioon aegunud versiooniks või nõutakse ülevaatamist. Ärge avaldage uuesti loodud tulemust vaikselt.

  1. 1

    Registreerige keeleversiooni kirje ja nõutavad metaandmed puhastus- ja REST-lubadega.

  2. 2

    Kaardistage toetatud Gutenbergi plokid ja määrake toetamata plokkide käitumine.

  3. 3

    Seadistage rollid ja lubatud olekuüleminekud.

  4. 4

    Looge eraldi redaktsioon ja esitage allikate võrdlus.

  5. 5

    Avaldage alles pärast sisu riskitaseme nõutavaid kinnitusi.

Hoidke vahemällu ohutult ja pakkuge vastupidavat keelenavigeerimist

Koostage vahemälu võtmed saidilt, lähtepostituse ID-st, allika versioonist, lokaadist, keelerežiimist ja renderdaja versioonist. Muutke seotud keele leht kehtetuks, kui selle heakskiidetud redaktsioon muutub, allikas muutub, jagatud plokk muutub või asjakohane terminoloogia reegel uuesti avaldatakse. Kui töötlemine toimub asünkroonselt, esitage uue mustandi ülevaatamise ajal viimane kinnitatud versioon. Ärge kunagi asendage heakskiidetud sisu tühja olekuga, kuna genereerimine pole saadaval.

Lisage keelelingid tavaliste serveris renderdatud ankrutena, millel on selged nimed, nagu „selge keel” ja „lihtsalt loetav ja mõistetav”. Lisage vastastikused lingid lähtelehele ja parandage alternatiivse keele metaandmeid. Säilitage klaviatuuri fookus pärast lehesisest ümberlülitamist ja teatage marsruudi muutmisest ainult tavalise lehe pealkirja ja pealkirja kaudu. Puuduv versioon peaks selgitama, et see pole saadaval, ja linkima tagasi allikaga, mitte peitma juhtelementi või vaikselt tagasi pöörduma.

  • Vahemälu võtmed sisaldavad allika ja renderdaja versioone.

  • Viimane kinnitatud leht elab üle API ja järjekorra katkestused.

  • Keelelingid töötavad ilma JavaScriptita ja kasutavad heakskiidetud terminoloogiat.

  • Kanoonilised ja alternatiivsed metaandmed kajastavad tegelikku suhet.

  • Jagatud plokkide ja sõnastiku muudatused käivitavad mõjutatud ülevaatusülesanded.

Testige täielikku avaldamise ja tagasipööramise teed

Kasutage esinduskoopiat Gutenbergi tüüpiliste plokkide, kohandatud väljade, manustatud vormide, korduvkasutatavate plokkide ja piiratud postitustega. Testi genereerimine, rolli jõustamine, kommentaaride ülevaatamine, ajastatud avaldamine, eelvaade, vahemälu kehtetuks tunnistamine, allika värskendamine, aegunud märgistamine, kustutamine, taastamine ja tagasivõtmine. Kinnitage, et REST-otspunktid lükkavad volitamata lugemised ja kirjutamised tagasi ning et taustatöid ei saa käivitada saidiüleselt ilma kehtivate nonce- või serverimandaatideta.

Enne tootmist määrake järjekorra jälgimine, vigade omandiõigus, mandaatide vaheldumine, pistikprogrammi värskenduste testimine, andmebaasi varundamine ja ohutu keelamisprotseduur. Nõustumiseks on vaja õiget renderdamist tavalistes katkestuspunktides, klaviatuuril ja ekraanilugejas navigeerimist, hilise sisu paigutuse nihutamist, kehtivaid struktureeritud pealkirju, jälgitavat kinnitamist ja viimase kinnitatud versiooni taastamist. Salvestage toetatud WordPress, PHP, redaktori, mitmekeelse pistikprogrammi ja vahemällu salvestamise konfiguratsioonid.

Rollid, tõendid ja heakskiit

Hoidke genereerimine avaldamisest eraldi. Edukas vastus on mustand, mitte heakskiit. Salvestage allika identifikaator ja versioon, teisendusseaded, tulemuse identifikaator, ülevaatuse olek, kinnitaja ja avaldamise aeg. Kui allikas muutub, märkige heakskiidetud sisu vaikselt asendamise asemel ülevaatamiseks keeleversioon. See muudab tagasipööramise ja auditi võimalikuks platvormide lõikes.

Toimingud ja hooldus

Töö avaldamisega ei lõpe. Linkige keeleversioon või konfiguratsioon selle allikaga, jälgige kvaliteedi- ja teenindusmeetmeid ning määrake konkreetsed ülevaatuse käivitajad. Käivitajad hõlmavad allikamuudatusi, juriidilisi muudatusi, uusi vaatajaskonna vajadusi, korduvaid tugiküsimusi, tehnilisi muudatusi ja vahejuhtumeid. Nimega omanik hindab päästikut, avab vajaduse korral uue versiooni ja registreerib uuendatud kinnituse.

Avaldamise kontrollnimekiri

  • Integreerimine kasutab püsivaid allikaidentifikaatoreid.

  • Mandaadid salvestatakse serveri poole ja neid pööratakse.

  • Määratud on ajalõpp, uuesti proovimine ja kiiruspiirangu käitumine.

  • Korduvad taotlused on idempotentsed.

  • Loodud sisu läheb ülevaatuse olekusse.

  • Allika muudatused muudavad versiooni kehtetuks või avavad selle uuesti.

  • Keeles navigeerimine töötab klaviatuuri ja abitehnoloogia abil.

  • Järelevalve hõlmab tõrkeid, järjekordi, latentsust ja aegunud sisu.

Usaldusväärsed allikad

  1. Simple8 API dokumentatsioon
  2. Simple8 tarnemustrid
  3. Veebisisu juurdepääsetavuse juhised (WCAG) 2.2

Rakendage juhend praktikas

Testige esindusliku sisuga Simple8-i ja kasutage kontrollitud tootmise töövoo kavandamiseks kontrollnimekirja.

Testige oma teksti