CMS in API

Vodnik za implementacijo Drupal.

Uporabite revizije Drupal, moderiranje vsebine in dovoljenja za ločevanje generiranja, strokovnega pregleda in objave.

Pojasnite nalogo in odločitev

Ta priročnik spremeni vodnik za implementacijo drupal 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.

Uporabite revizije Drupal, moderiranje vsebine in dovoljenja za ločevanje generiranja, strokovnega pregleda in objave.

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

Moderirana vrsta vsebine prikazuje polja, vloge, revizije, dostavo in povrnitev nazaj. 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

Ustvarite model vsebine, ki ohranja poreklo

Ustvarite vrsto vsebine v dostopnem jeziku ali strukturirano entiteto s sklicem entitete na verodostojni vir. Vključite ID izvorne revizije, jezik, jezikovni način, ID rezultata, stanje pregleda, različico glosarja, stopnjo tveganja, odobritelje in naslednji sprožilec pregleda. Uporabite odstavke ali strukturirana polja za naslove, sezname, povezave, obvestila, prenose in kontaktne informacije. Eno samo neomejeno polje z obogatenim besedilom oteži preverjanje na ravni polja, ponovno uporabo in varno upodabljanje.

Premišljeno izberite med prevodno relacijo Drupal in ločeno povezano entiteto. Standardni prevod deluje, ko struktura polja in življenjski cikel urednika ostaneta enakovredna. Ločena entiteta je varnejša, če dostopna različica združuje, preureja ali razlaga izvorna polja in potrebuje drugačno moderiranje. V obeh primerih ohranite izvorno revizijo nespremenljivo za transformacijo in prikažite zastarelo stanje, ko se trenutni vir ne ujema več z njim.

Izbira dizajnaUporabite kdajZahtevana zaščita
Prevajanje vsebineStruktura in življenjski cikel ostajata enakovrednaPrizadet prevod revizije in moderiranje
Povezani subjektStruktura, lastništvo ali pregled se razlikujejoEksplicitna referenca vira in vzajemna navigacija
Preslikava odstavkovVir vsebuje strukturirane bloke za večkratno uporaboNepodprto ustvarjanje blokov svežnjev ali zastavic

Ločeno ustvarjanje, strokovni pregled in objava

Konfigurirajte stanja moderiranja vsebine, kot so zahtevano, generiranje, osnutek, pregled zadeve, pregled jezika, odobreno, objavljeno, zastarelo in neuspešno. Določite prehode za namenske vloge in jih preverite z dovoljenji Drupal in upravljavci dostopa. Integracijski račun API lahko ustvari in posodobi osnutek, ne more pa odobriti ali objaviti. Predmetni pregledovalec ne more odobriti lastne generacije z visokim tveganjem, razen če dokumentirana politika tveganja tega dovoljuje.

Omogočite revizije in zagotovite, da vsaka transformacija, razrešitev komentarja, prehod stanja in ponovna osnova vira ustvarijo revizijo z avtorjem in časovnim žigom. Zgradite pogled pregleda, ki prikazuje vir in osnutek, razlike, opozorila, povezave in upodobljeni rezultat. Če se vir spremeni, ustrezno označite aktivni osnutek in objavljeno različico ter blokirajte objavo, dokler recenzent ne odpravi neujemanja.

  1. 1

    Konfigurirajte polja entitete, preverjanje, revizije in izvorno razmerje.

  2. 2

    Ustvarite stanja moderiranja in prehode, specifične za vlogo.

  3. 3

    Ustvarite osnutek prek delavca z omejeno čakalno vrsto.

  4. 4

    Popolni predmetni in jezikovni pregledi na eni identificirani reviziji.

  5. 5

    Objavite, indeksirajte in obdržite revizijsko sled od vira do objave.

Dostavite z nedotaknjeno možnostjo predpomnilnika Drupal in dostopnostjo

Priložite oznake predpomnilnika za izvorno entiteto, razmerje izvorne revizije, jezikovno entiteto, referenčne odstavke in medije, konfiguracijo glosarja in upodabljalnik. Uporabite predpomnilniške kontekste za področne nastavitve in morebitne legitimne različice dostopa, vendar odobrenih javnih strani ne postavljajte v odvisnost od stanja generiranja, specifičnega za uporabnika. Razveljavite zadevne strani s spremembami entitet ali dokončanjem čakalne vrste in ohranite vidno zadnjo odobreno revizijo, medtem ko se pregleduje zamenjava.

Upodobi jezikovno navigacijo kot običajne povezave z usmerjanjem Drupal in generiranjem URL-jev, ki upošteva jezik. Dodajte vzajemne izvorne povezave, metapodatke v drugem jeziku, drobtinice in vnose na zemljevidu spletnih mest. Preverite hierarhijo naslovov, namen povezave, vrstni red fokusa, sporočila o stanju in povezavo napak obrazca v končni temi. Očistite izhod API prek dovoljenih strukturiranih polj in sistema upodabljanja Drupal. Ustvarjenega HTML-ja nikoli ne označite kot varnega samo zato, ker prihaja iz zaupanja vrednega strežnika.

  • Oznake predpomnilnika zajemajo izvor, jezikovno različico, komponente, medije, glosar in upodabljalnik.

  • Obdelava čakalne vrste ne more predčasno objaviti vsebine ali počistiti zadnjega odobrenega rezultata.

  • Jezikovne poti in izvorne povezave delujejo brez JavaScripta.

  • Oblike besedila in nizi upodabljanja preprečujejo nevarno označevanje.

  • Iskanje indeksira samo odobreno revizijo in odstrani umaknjene poti.

Dokažite dovoljenja, revizije in povrnitev

Jedro in funkcionalni testi morajo zajemati preverjanje polja, nadzor dostopa, prehode moderiranja, ustvarjanje revizije, zaznavanje zastarelega vira, ponovne poskuse v čakalni vrsti, razveljavitev predpomnilnika, dostop do poti in upodabljanje vsake podprte komponente. Preizkusite cron Drupal in zunanje izvajalce čakalne vrste, vključno s prekrivajočimi se delavci in ponavljajočimi se opravili. Preizkusi brskalnika bi morali izvajati celoten uredniški potek dela z vsako vlogo in uporabo čelnega vmesnika samo s tipkovnico.

Izdaja z upravljanjem konfiguracije, posodobitvenimi kljukicami, rotacijo poverilnic, nadzornimi ploščami čakalnih vrst, ponovnim predvajanjem neuspešnega opravila, minimiziranjem dnevnika, varnostnim kopiranjem baze podatkov in rollback runbookom. Uvozite konfiguracijo v okolje, podobno produkciji, in potrdite, da obstoječi svežnji, prevodi, dovoljenja in pogledi ostanejo nedotaknjeni. Sprejetje vključuje obnovitev prejšnje odobrene revizije, ponovno izgradnjo predpomnilnikov in indeksov ter potrditev, da javni URL-ji in revizijski zapisi ostajajo pravilni.

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