CMS in API

Vodnik za implementacijo WordPress.

Premišljeno izberite dostavo pripomočkov ali API, ohranite izvirno stran kanonično in objavite jezikovne različice z revizijami.

Pojasnite nalogo in odločitev

Ta priročnik spremeni vodnik za implementacijo wordpress v potek dela, ki ga je mogoče pregledati. Povezuje domenske odločitve, lastništvo, dokaze in sprejemanje, tako da rezultat še naprej deluje v proizvodnji.

Premišljeno izberite dostavo pripomočkov ali API, ohranite izvirno stran kanonično in objavite jezikovne različice z revizijami.

Praktični postopek

  1. 1

    Vrste virov inventarja, identifikatorji, polja, lokalne nastavitve, lastniki in stanja objave.

  2. 2

    Izberite vzorec dostave med glasnostjo, zakasnitvijo, uredniškim nadzorom in toleranco napak.

  3. 3

    Preslikaj izvorni zapis v ločen zapis jezikovne različice s trajno povezavo.

  4. 4

    Dodajte preverjanje pristnosti, idempotenco, ponovni poskus, razveljavitev predpomnilnika, beleženje in nadzor dostopa.

  5. 5

    Preskusna objava, spremembe vira, nerazpoložljivi rezultati, povrnitev nazaj, delovanje tipkovnice in spremljanje pred izdajo.

Primer ali orodje

Gutenbergov potek dela preslika izvorne strani, stanja pregleda, ključe predpomnilnika in jezikovno navigacijo. V orodju zabeležite tudi izhodišče, lastnika, odločitev, dokaze, odprto vprašanje in datum odobritve. Uporabite pravo stran ali transakcijo, da bo skupina videla odvisnosti, izjeme in vzdrževalna dela, ki sledijo izdaji.

Točka odločitveZapisKriterij sprejemljivosti
IzhodiščeOpaženo trenutno stanjeVir in datum zapisa
OdločitevIzbrana možnost in utemeljitevUpoštevano je tveganje in občinstvo
DokaziPreizkusite, dokumentirajte ali izmeritePregledljiv in specifičen za različico
OdobritevIme, vloga in datumIzpolnjeni vsi obvezni kriteriji

Izberite gradnik, vtičnik ali dostavo API na strani strežnika

Uporabite gradnik, ko je hitrost uvajanja pomembna, izvorne strani že imajo trajne identifikatorje in je odvisnost na strani odjemalca sprejemljiva. Uporabite vtičnik WordPress, ko uredniki potrebujejo ustvarjanje in pregled znotraj skrbniškega vmesnika. Uporabite dostavo API na strani strežnika, ko je treba jezikovne različice indeksirati, predpomniti, vključiti v vire in upodobiti, tudi če JavaScript ni na voljo. Veliki založniki pogosto kombinirajo vtičnik za potek dela z upodabljanjem na strani strežnika za dostavo.

Dokumentirajte izbiro glede uredniškega nadzora, zmogljivosti, dostopnosti, iskanja, vedenja pri napakah, pretoka podatkov in lastništva vzdrževanja. Izvirna stran ostaja verodostojen vir. Jezikovna različica dobi svojo objavo ali strukturiran zapis, stabilen URL, status pregleda in povezavo do revizije vira. Izogibajte se shranjevanju nadomestne vsebine samo v polje po meri brez različic ali predpomnilnik brskalnika, ker je pregledovalci ne morejo zanesljivo odobriti, obnoviti ali revidirati.

VzorecNajboljše prileganjePrimarni nadzor
WidgetHiter dodatek na nadzorovano mestoDostopno nadomestno stanje in stanje napake
Potek dela vtičnikaUredniki v celoti delajo v WordPressVloge, nonce, zmožnosti in revizije
Strežniška stran APIIndeksirane, odporne strani z možnostjo predpomnilnikaČakalna vrsta, razveljavitev predpomnilnika in operacije uvajanja

Modelirajte izvorna razmerja in uredniška stanja

Ustvarite vrsto objave jezikovne različice ali uporabite večjezično strukturo, ki podpira eksplicitna izvorna razmerja. Shranite ID izvorne objave, ID izvorne revizije, ciljni jezik, jezikovni način, ID rezultata, različico glosarja, stanje pregleda, odobritelje, objavljeno revizijo in sprožilec pregleda. Ohranite preoblikovano strukturo blokov, kjer je to mogoče, tako da naslovi, seznami, povezave, tabele in obvestila ostanejo semantični, namesto da bi bili sploščeni v eno polje HTML.

Določite statuse za zahtevano, generiranje, osnutek, predmetni pregled, jezikovni pregled, odobreno, objavljeno, zastarelo in neuspešno. Preslikajte vsak prehod v zmogljivost WordPress, ne le v vidni gumb. Generator lahko ustvari osnutek, vendar ga ne more odobriti. Ko se izvor spremeni, primerjajte njegovo revizijo z odobreno izvorno revizijo in premaknite jezikovno različico na zastarelo ali pa je potreben pregled. Ne objavljajte tiho ponovnega rezultata.

  1. 1

    Registrirajte zapis jezikovne različice in zahtevane metapodatke z dovoljenji za čiščenje in REST.

  2. 2

    Preslikajte podprte Gutenbergove bloke in določite vedenje za nepodprte bloke.

  3. 3

    Konfigurirajte vloge in dovoljene statusne prehode.

  4. 4

    Ustvarite v ločeni reviziji in predstavite izvorno primerjavo.

  5. 5

    Objavite le po zahtevanih odobritvah za stopnjo tveganja vsebine.

Varno predpomnite in zagotovite trajno jezikovno navigacijo

Zgradite ključe predpomnilnika iz mesta, ID-ja izvorne objave, izvorne revizije, področne nastavitve, jezikovnega načina in različice upodabljalnika. Razveljavi sorodno jezikovno stran, ko se spremeni njena odobrena revizija, vir, blok v skupni rabi ali je ponovno objavljeno ustrezno terminološko pravilo. Če obdelava poteka asinhrono, postrezite zadnjo odobreno različico, medtem ko je nov osnutek pregledan. Nikoli ne zamenjajte odobrene vsebine s praznim stanjem, ker ustvarjanje ni na voljo.

Dodajte jezikovne povezave kot običajna strežniško upodobljena sidra z jasnimi imeni, kot sta »jasen jezik« in »lahko berljivo in razumljivo«. Vključite vzajemne povezave do izvorne strani in pravilne metapodatke v drugem jeziku. Ohranite fokus tipkovnice po preklopu na strani in naznanite spremembo poti samo prek običajnega naslova in naslova strani. Manjkajoča različica mora pojasniti, da ni na voljo, in se povezati nazaj z virom, ne pa skriti nadzora ali se tiho vrniti nazaj.

  • Ključi predpomnilnika vključujejo izvorno različico in različico upodabljalnika.

  • Zadnja odobrena stran preživi API in izpade v čakalni vrsti.

  • Jezikovne povezave delujejo brez JavaScripta in uporabljajo odobreno terminologijo.

  • Kanonični in nadomestni metapodatki odražajo dejansko razmerje.

  • Spremembe skupnega bloka in glosarja sprožijo prizadeta opravila pregleda.

Preizkusite celotno pot objave in povrnitve

Uporabite uprizoritveno kopijo z reprezentativnimi Gutenbergovimi bloki, polji po meri, vdelanimi obrazci, bloki za večkratno uporabo in omejenimi objavami. Generiranje testa, uveljavljanje vlog, pregled komentarjev, načrtovana objava, predogled, razveljavitev predpomnilnika, posodobitev vira, zastarelo označevanje, brisanje, obnovitev in povrnitev nazaj. Prepričajte se, da končne točke REST zavračajo nepooblaščeno branje in pisanje in da opravil v ozadju ni mogoče sprožiti med spletnimi mesti brez veljavnih poverilnic za enkratno uporabo ali poverilnic strežnika.

Pred produkcijo definirajte spremljanje čakalne vrste, lastništvo napak, rotacijo poverilnic, testiranje posodobitve vtičnika, varnostno kopiranje baze podatkov in postopek varne onemogočitve. Sprejem zahteva pravilno upodabljanje na običajnih prelomnih točkah, navigacijo s tipkovnico in bralnikom zaslona, ​​brez premikanja postavitve od pozne vsebine, veljavne strukturirane naslove, sledljivo odobritev in obnovitev zadnje odobrene revizije. Posnemite podprte konfiguracije WordPress, PHP, urejevalnika, večjezičnega vtičnika in predpomnjenja.

Vloge, dokazi in odobritev

Generiranje naj bo ločeno od objave. Uspešen odgovor je osnutek, ne odobritev. Shranite izvorni identifikator in različico, nastavitve transformacije, identifikator rezultata, stanje pregleda, odobritelja in čas objave. Ko se vir spremeni, označite jezikovno različico za pregled, namesto da tiho zamenjate odobreno vsebino. To omogoča povrnitev in revizijo na vseh platformah.

Delovanje in vzdrževanje

Delo se ne konča z objavo. Povežite jezikovno različico ali konfiguracijo z njenim izvorom, spremljajte ukrepe kakovosti in storitev ter definirajte konkretne sprožilce pregleda. Sprožilci vključujejo spremembe vira, pravne spremembe, nove potrebe občinstva, ponavljajoča se vprašanja podpore, tehnične spremembe in incidente. Imenovani lastnik oceni sprožilec, po potrebi odpre novo revizijo in zabeleži ponovno odobritev.

Kontrolni seznam za objavo

  • Integracija uporablja trajne izvorne identifikatorje.

  • Poverilnice so shranjene na strani strežnika in se izmenjujejo.

  • Določeni so časovna omejitev, ponovni poskus in omejitev hitrosti.

  • Ponavljajoče se zahteve so idempotentne.

  • Ustvarjena vsebina preide v stanje pregleda.

  • Spremembe vira razveljavijo ali znova odprejo različico.

  • Jezikovna navigacija deluje s pomočjo tipkovnice in podporne tehnologije.

  • Spremljanje zajema napake, čakalne vrste, zakasnitev in zastarelo vsebino.

Verodostojni viri

  1. Dokumentacija Simple8 API
  2. Simple8 vzorci dostave
  3. Smernice za dostopnost spletne vsebine (WCAG) 2.2

Uporabite vodnik v praksi

Preizkusite Simple8 z reprezentativno vsebino in uporabite kontrolni seznam za načrtovanje nadzorovanega delovnega toka proizvodnje.

Preizkusite svoje besedilo