CMS u API

Gwida ta 'implimentazzjoni Drupal.

Uża reviżjonijiet Drupal, moderazzjoni tal-kontenut, u permessi biex tissepara ġenerazzjoni, reviżjoni speċjalizzata, u pubblikazzjoni.

Iċċara l-kompitu u d-deċiżjoni

Din il-gwida ddawwar il-gwida ta 'implimentazzjoni drupal fi fluss tax-xogħol operattiv li jista' jiġi rivedut. Tgħaqqad id-deċiżjonijiet tad-dominju, is-sjieda, l-evidenza u l-aċċettazzjoni sabiex ir-riżultat ikompli jaħdem fil-produzzjoni.

Uża reviżjonijiet Drupal, moderazzjoni tal-kontenut, u permessi biex tissepara ġenerazzjoni, reviżjoni speċjalizzata, u pubblikazzjoni.

Proċess prattiku

  1. 1

    Tipi ta 'sors ta' inventarju, identifikaturi, oqsma, lokalitajiet, sidien, u stati ta 'pubblikazzjoni.

  2. 2

    Agħżel il-mudell tal-kunsinna minn volum, latency, kontroll editorjali, u tolleranza ta 'falliment.

  3. 3

    Immappja r-rekord tas-sors għal rekord separat tal-verżjoni tal-lingwa b'rabta durabbli.

  4. 4

    Żid awtentikazzjoni, idempotenza, ipprova mill-ġdid, invalidazzjoni tal-cache, illoggjar, u kontrolli tal-aċċess.

  5. 5

    Pubblikazzjoni tat-test, bidliet fis-sors, riżultati mhux disponibbli, rollback, tħaddim tat-tastiera, u monitoraġġ qabel ir-rilaxx.

Eżempju jew għodda

Tip ta' kontenut immoderat juri oqsma, rwoli, reviżjonijiet, kunsinna, u rollback. Fl-għodda, irreġistra wkoll il-linja bażi, is-sid, id-deċiżjoni, l-evidenza, il-ħruġ miftuħ u d-data tal-approvazzjoni. Uża paġna jew transazzjoni reali sabiex it-tim jara dipendenzi, eċċezzjonijiet, u x-xogħol ta 'manutenzjoni li jsegwi r-rilaxx.

Punt tad-deċiżjoniRekordKriterju ta' aċċettazzjoni
Linja bażiStat attwali osservatSors u data rreġistrati
DeċiżjoniGħażla magħżula u raġuniRiskju u udjenza kkunsidrati
EvidenzaTest, dokument, jew kejlRivedibbli u speċifiku għall-verżjoni
ApprovazzjoniIsem, rwol, u dataIl-kriterji obbligatorji kollha sodisfatti

Oħloq mudell ta' kontenut li jippreserva l-provenjenza

Oħloq tip ta' kontenut b'lingwa aċċessibbli jew entità strutturata b'referenza ta' entità għas-sors awtorevoli. Inkludi l-ID tar-reviżjoni tas-sors, il-lokal, il-mod tal-lingwa, l-ID tar-riżultat, l-istat tar-reviżjoni, il-verżjoni tal-glossarju, il-livell tar-riskju, l-approvaturi, u l-iskattar tar-reviżjoni li jmiss. Uża paragrafi jew oqsma strutturati għal intestaturi, listi, links, avviżi, downloads, u informazzjoni ta 'kuntatt. Field singolu ta' test sinjuri mhux ristrett jagħmel il-validazzjoni fil-livell tal-qasam, l-użu mill-ġdid, u l-għoti sikur aktar diffiċli.

Agħżel deliberatament bejn ir-relazzjoni ta’ traduzzjoni ta’ Drupal u entità relatata separata. It-traduzzjoni standard taħdem meta l-istruttura tal-qasam u ċ-ċiklu tal-ħajja editorjali jibqgħu ekwivalenti. Entità separata hija aktar sigura meta l-verżjoni aċċessibbli tgħaqqad, tordna mill-ġdid, jew tispjega l-oqsma tas-sors u teħtieġ moderazzjoni differenti. Fiż-żewġ każi, żomm ir-reviżjoni tas-sors immutabbli għat-trasformazzjoni u turi l-istatus ta' skadenza meta s-sors kurrenti ma jibqax jaqbel miegħu.

Għażla tad-disinnUża metaSalvagwardja meħtieġa
Traduzzjoni tal-kontenutL-istruttura u ċ-ċiklu tal-ħajja jibqgħu ekwivalentiIt-traduzzjoni tar-reviżjoni affettwata u l-moderazzjoni ttestjata
Entità relatataL-istruttura, is-sjieda, jew ir-reviżjoni huma differentiReferenza ta' sors espliċitu u navigazzjoni reċiproka
Immappjar tal-paragrafuIs-sors fih blokki strutturati li jistgħu jerġgħu jintużawĠenerazzjoni ta' blokki jew bnadar mhux appoġġjati

Ħolqien separat, reviżjoni speċjalizzata, u pubblikazzjoni

Ikkonfigura stati tal-Moderazzjoni tal-Kontenut bħal mitluba, ġenerazzjoni, abbozz, reviżjoni tas-suġġett, reviżjoni tal-lingwa, approvat, ippubblikat, skadut, u fallut. Iddefinixxi tranżizzjonijiet għal rwoli ddedikati u vverifikahom bil-permessi Drupal u bl-aċċess handlers. Il-kont ta 'integrazzjoni API jista' joħloq u jaġġorna abbozz iżda ma jistax japprova jew jippubblika. Reviżur tas-suġġett ma jistax japprova l-ġenerazzjoni ta' riskju għoli tiegħu stess sakemm il-politika ta' riskju dokumentata ma tippermettix dan.

Ippermetti r-reviżjonijiet u tiżgura li kull trasformazzjoni, riżoluzzjoni tal-kumment, transizzjoni tal-istatus, u ribażi tas-sors toħloq reviżjoni bl-awtur u l-timestamp. Ibni dehra ta' reviżjoni li turi s-sors u l-abbozz, id-differenzi, it-twissijiet, ir-rabtiet, u r-riżultat mogħti. Jekk is-sors jinbidel, immarka l-abbozz attiv u l-verżjoni ppubblikata b'mod xieraq u imblokka l-pubblikazzjoni sakemm reviżur isolvi n-nuqqas ta' qbil.

  1. 1

    Ikkonfigura l-oqsma tal-entità, il-validazzjoni, ir-reviżjonijiet, u r-relazzjoni tas-sors.

  2. 2

    Oħloq stati ta’ moderazzjoni u tranżizzjonijiet speċifiċi għar-rwoli.

  3. 3

    Iġġenera abbozz permezz ta' ħaddiem tal-kju ristrett.

  4. 4

    Tlesti reviżjonijiet tas-suġġett u tal-lingwa fuq reviżjoni waħda identifikata.

  5. 5

    Ippubblika, indiċi, u żżomm it-traċċa tal-verifika mis-sors sal-rilaxx.

Twassil b'cacheability u aċċessibbiltà Drupal intatti

Waħħal tikketti tal-cache għall-entità sors, ir-relazzjoni tar-reviżjoni tas-sors, l-entità tal-lingwa, il-paragrafi u l-midja referenzjati, il-konfigurazzjoni tal-glossarju, u r-renderer. Uża kuntesti tal-cache għal lokali u kwalunkwe varjazzjoni ta' aċċess leġittimu, iżda ma tagħmilx il-paġni pubbliċi approvati jiddependu fuq l-istat tal-ġenerazzjoni speċifiku għall-utent. Invalida l-paġni affettwati permezz ta' bidliet ta' entità jew tlestija tal-kju, u żomm l-aħħar reviżjoni approvata viżibbli waqt li sostituzzjoni tiġi riveduta.

Agħti n-navigazzjoni tal-lingwa bħala links ordinarji permezz tar-routing Drupal u l-ġenerazzjoni tal-URL konxja tal-lingwa. Żid links ta' sors reċiproku, metadejta b'lingwa alternata, frak tal-ħobż, u entrati fil-mappa tas-sit. Ivverifika l-ġerarkija tal-intestatura, l-iskop tal-link, l-ordni tal-fokus, il-messaġġi tal-istatus, u tifforma assoċjazzjoni tal-iżball fit-tema finali. Sanitizza l-output ta’ API permezz ta’ oqsma strutturati permessi u s-sistema ta’ rendering ta’ Drupal. Qatt mmarka HTML iġġenerat sikur sempliċement minħabba li ġie minn server fdat.

  • Tikketti tal-cache jkopru s-sors, il-verżjoni tal-lingwa, il-komponenti, il-midja, il-glossarju u r-renderer.

  • L-ipproċessar tal-kju ma jistax jippubblika kontenut jew ineħħi l-aħħar riżultat approvat qabel iż-żmien.

  • Ir-rotot tal-lingwa u l-links tas-sors jaħdmu mingħajr JavaScript.

  • Il-formati tat-test u l-matriċi tar-rendi jipprevjenu l-markup mhux sigur.

  • Fittex indiċi biss ir-reviżjoni approvata u tneħħi rotot irtirati.

Ipprova permessi, reviżjonijiet, u rollback

It-testijiet tal-kernel u funzjonali għandhom ikopru validazzjoni tal-kamp, ​​kontroll tal-aċċess, transizzjonijiet ta’ moderazzjoni, ħolqien ta’ reviżjoni, skoperta ta’ sors skadut, provi mill-ġdid tal-kju, invalidazzjoni tal-cache, aċċess tar-rotta, u għoti ta’ kull komponent appoġġjat. Ittestja Drupal cron u runners esterni tal-kju, inklużi ħaddiema li jikkoinċidu u impjiegi ripetuti. It-testijiet tal-browser għandhom jeżerċitaw il-fluss tax-xogħol editorjali sħiħ ma 'kull rwol u użu ta' frontend tat-tastiera biss.

Rilaxx b'ġestjoni tal-konfigurazzjoni, ganċijiet ta 'aġġornament, rotazzjoni tal-kredenzjali, dashboards tal-kju, replay ta' xogħol fallut, minimizzazzjoni ta 'log, backup tad-database, u runbook ta' rollback. Importa konfigurazzjoni f'ambjent bħal produzzjoni u kkonferma li bundles eżistenti, traduzzjonijiet, permessi, u fehmiet jibqgħu intatti. L-aċċettazzjoni tinkludi r-restawr ta’ reviżjoni approvata preċedenti, il-bini mill-ġdid tal-caches u l-indiċi, u l-konferma li l-URLs pubbliċi u r-rekords tal-awditjar jibqgħu korretti.

Rwoli, evidenza, u approvazzjoni

Żomm il-ġenerazzjoni separata mill-pubblikazzjoni. Reazzjoni b'suċċess hija abbozz, mhux approvazzjoni. Aħżen l-identifikatur tas-sors u l-verżjoni, is-settings tat-trasformazzjoni, l-identifikatur tar-riżultat, l-istat tar-reviżjoni, l-approvazzjoni, u l-ħin tal-pubblikazzjoni. Meta s-sors jinbidel, immarka l-verżjoni tal-lingwa għal reviżjoni minflok ma tissostitwixxi bil-kwiet il-kontenut approvat. Dan jagħmel ir-rollback u l-awditjar possibbli fuq il-pjattaformi kollha.

Operazzjonijiet u manutenzjoni

Ix-xogħol ma jispiċċax mal-pubblikazzjoni. Qabbad il-verżjoni tal-lingwa jew il-konfigurazzjoni mas-sors tagħha, timmonitorja l-kwalità u l-miżuri tas-servizz, u ddefinixxi l-kawżi konkreti tar-reviżjoni. It-tqanqil jinkludu bidliet fis-sors, bidliet legali, ħtiġijiet ġodda ta 'udjenza, mistoqsijiet ta' appoġġ rikorrenti, bidliet tekniċi, u inċidenti. Sid imsemmi jevalwa l-grillu, jiftaħ reviżjoni ġdida meta jkun meħtieġ, u jirreġistra approvazzjoni mġedda.

Lista ta' kontroll għall-pubblikazzjoni

  • L-integrazzjoni tuża identifikaturi tas-sors durabbli.

  • Il-kredenzjali huma maħżuna fuq in-naħa tas-server u mdawra.

  • Il-timeout, il-prova mill-ġdid, u l-imġieba tal-limitu tar-rata huma definiti.

  • Talbiet ripetuti huma idempotenti.

  • Il-kontenut iġġenerat jidħol fi stat ta' reviżjoni.

  • Il-bidliet fis-sors jinvalidaw jew jerġgħu jiftħu l-verżjoni.

  • In-navigazzjoni lingwistika taħdem bit-tastiera u t-teknoloġija assistiva.

  • Il-monitoraġġ ikopri fallimenti, kjuwijiet, latency, u kontenut mhux użat.

Sorsi awtorevoli

  1. Simple8 API dokumentazzjoni
  2. Mudelli ta 'kunsinna Simple8
  3. Linji Gwida għall-Aċċessibilità tal-Kontenut tal-Web (WCAG) 2.2

Poġġi l-gwida fil-prattika

Ittestja Simple8 b'kontenut rappreżentattiv u uża l-lista ta 'kontroll biex tippjana fluss tax-xogħol ta' produzzjoni kkontrollat.

Ittestja t-test tiegħek