CMS un API

Drupal ieviešanas rokasgrāmata.

Izmantojiet Drupal versijas, satura regulēšanu un atļaujas, lai atdalītu ģenerēšanu, speciālistu pārskatīšanu un publicēšanu.

Noskaidrojiet uzdevumu un lēmumu

Šī rokasgrāmata pārvērš drupal ieviešanas rokasgrāmatu par pārskatāmu darbības darbplūsmu. Tas savieno domēna lēmumus, īpašumtiesības, pierādījumus un pieņemšanu, lai rezultāts turpinātu darboties ražošanā.

Izmantojiet Drupal versijas, satura regulēšanu un atļaujas, lai atdalītu ģenerēšanu, speciālistu pārskatīšanu un publicēšanu.

Praktiskā darba gaita

  1. 1

    Krājumu avotu veidi, identifikatori, lauki, lokalizācijas, īpašnieki un publikācijas stāvokļi.

  2. 2

    Izvēlieties piegādes modeli no skaļuma, latentuma, redakcionālās kontroles un kļūdu pielaides.

  3. 3

    Kartējiet avota ierakstu ar atsevišķu valodas versijas ierakstu ar izturīgu saiti.

  4. 4

    Pievienojiet autentifikāciju, idempotenci, atkārtotu mēģinājumu, kešatmiņas nederīgumu, reģistrēšanu un piekļuves vadīklas.

  5. 5

    Testa publikācija, avota izmaiņas, nepieejami rezultāti, atcelšana, tastatūras darbība un uzraudzība pirms izlaišanas.

Piemērs vai rīks

Moderēta satura tips parāda laukus, lomas, pārskatījumus, piegādi un atcelšanu. Rīkā ierakstiet arī sākotnējo stāvokli, īpašnieku, lēmumu, pierādījumus, atklāto jautājumu un apstiprināšanas datumu. Izmantojiet īstu lapu vai darījumu, lai komanda redzētu atkarības, izņēmumus un uzturēšanas darbus pēc izlaišanas.

Lēmuma punktsIerakstsPieņemšanas kritērijs
PamatlīnijaNovērots pašreizējais stāvoklisAvots un ierakstīšanas datums
LēmumsIzvēlētais variants un pamatojumsApsvērts risks un auditorija
PierādījumiPārbaudi, dokumentē vai mēraPārskatāms un konkrētai versijai
ApstiprināšanaVārds, loma un datumsVisi obligātie kritēriji ir izpildīti

Izveidojiet satura modeli, kas saglabā izcelsmi

Izveidojiet pieejamās valodas satura veidu vai strukturētu entītiju ar entītijas atsauci uz autoritatīvu avotu. Iekļaujiet avota pārskatīšanas ID, lokalizāciju, valodas režīmu, rezultāta ID, pārskatīšanas stāvokli, glosārija versiju, riska līmeni, apstiprinātājus un nākamās pārskatīšanas aktivizētāju. Izmantojiet rindkopas vai strukturētus laukus virsrakstiem, sarakstiem, saitēm, paziņojumiem, lejupielādēm un kontaktinformācijai. Viens neierobežots bagātinātā teksta lauks apgrūtina lauka līmeņa validāciju, atkārtotu izmantošanu un drošu renderēšanu.

Apzināti izvēlieties starp Drupal tulkošanas relāciju un atsevišķu saistītu entītiju. Standarta tulkošana darbojas, ja lauka struktūra un redakcijas dzīves cikls paliek līdzvērtīgi. Atsevišķa entītija ir drošāka, ja pieejamā versija apvieno, pārkārto vai izskaidro avota laukus un tai ir nepieciešama atšķirīga regulēšana. Jebkurā gadījumā saglabājiet avota versiju nemainīgu transformācijai un parādiet novecojušu statusu, kad pašreizējais avots tam vairs neatbilst.

Dizaina izvēleIzmantojiet, kadNepieciešamā aizsardzība
Satura tulkošanaStruktūra un dzīves cikls paliek līdzvērtīgiPārskatīšanas tulkojums ir ietekmēts, un moderācija ir pārbaudīta
Saistītā vienībaStruktūra, īpašumtiesības vai pārskats atšķirasSkaidra atsauce uz avotu un savstarpēja navigācija
Rindkopu kartēšanaAvots satur atkārtoti lietojamus strukturētus blokusNeatbalstītu komplektu bloku vai karodziņu ģenerēšana

Atsevišķa izveide, speciālistu apskats un publikācija

Konfigurējiet satura regulēšanas stāvokļus, piemēram, pieprasīts, ģenerēšana, melnraksts, tēmas pārskatīšana, valodas pārskatīšana, apstiprināta, publicēta, novecojusi un neizdevusies. Definējiet pārejas īpašām lomām un pārbaudiet tās, izmantojot Drupal atļaujas un piekļuves apstrādātājus. API integrācijas konts var izveidot un atjaunināt melnrakstu, bet nevar apstiprināt vai publicēt. Priekšmeta pārskatītājs nevar apstiprināt savu augsta riska ģenerēšanu, ja vien to neatļauj dokumentētā riska politika.

Iespējojiet pārskatīšanu un nodrošiniet, lai katra transformācija, komentāru atrisināšana, statusa pāreja un avota atkārtota bāze izveidotu pārskatīšanu ar autoru un laikspiedolu. Izveidojiet pārskatīšanas skatu, kas parāda avotu un melnrakstu, atšķirības, brīdinājumus, saites un renderēto rezultātu. Ja avots mainās, atbilstoši atzīmējiet aktīvo melnrakstu un publicēto versiju un bloķējiet publicēšanu, līdz pārskatītājs novērsīs neatbilstību.

  1. 1

    Konfigurējiet entītiju laukus, validāciju, pārskatījumus un avota attiecības.

  2. 2

    Izveidojiet moderēšanas stāvokļus un lomai atbilstošas pārejas.

  3. 3

    Ģenerējiet melnrakstu, izmantojot ierobežotas rindas darbinieku.

  4. 4

    Aizpildiet tēmas un valodas pārskatus par vienu identificētu pārskatīšanu.

  5. 5

    Publicējiet, indeksējiet un saglabājiet audita liecības no avota līdz izlaišanai.

Nodrošiniet ar neskartu Drupal kešatmiņu un pieejamību

Pievienojiet kešatmiņas tagus avota entītijai, avota pārskatīšanas attiecībām, valodas entītijai, atsauces rindkopām un multividei, glosārija konfigurācijai un renderētājam. Izmantojiet kešatmiņas kontekstu lokalizācijai un jebkuram likumīgam piekļuves variantam, taču nepadariet apstiprinātās publiskās lapas atkarīgas no lietotāja specifiskā ģenerēšanas stāvokļa. Nederīgas ietekmētās lapas, veicot entītiju izmaiņas vai rindas pabeigšanu, un saglabājiet pēdējo apstiprināto pārskatīšanu redzamu, kamēr tiek pārskatīta aizstāšana.

Atveidojiet valodas navigāciju kā parastas saites, izmantojot Drupal maršrutēšanu un valodu apzinošu URL ģenerēšanu. Pievienojiet abpusējas avota saites, alternatīvu valodu metadatus, rīvmaiņas un vietnes kartes ierakstus. Galīgajā motīvā pārbaudiet virsrakstu hierarhiju, saites mērķi, fokusa secību, statusa ziņojumus un formas kļūdu saistību. Dezinficējiet API izvadi, izmantojot atļautos strukturētos laukus un Drupal renderēšanas sistēmu. Nekad neatzīmējiet ģenerēto HTML kā drošu tikai tāpēc, ka tas nāk no uzticama servera.

  • Kešatmiņas tagi aptver avotu, valodas versiju, komponentus, multividi, glosāriju un renderētāju.

  • Rindas apstrāde nevar publicēt saturu vai priekšlaicīgi notīrīt pēdējo apstiprināto rezultātu.

  • Valodu maršruti un avotu saites darbojas bez JavaScript.

  • Teksta formāti un renderēšanas masīvi novērš nedrošu iezīmēšanu.

  • Meklēšana indeksē tikai apstiprināto versiju un noņem pārtrauktos maršrutus.

Pierādiet atļaujas, labojumus un atcelšanu

Kodola un funkcionālajiem testiem jāaptver lauka validācija, piekļuves kontrole, moderēšanas pārejas, pārskatījumu izveide, novecojuša avota noteikšana, rindas atkārtojumi, kešatmiņas nederīgums, piekļuve maršrutam un katra atbalstītā komponenta renderēšana. Pārbaudiet Drupal cron un ārējos rindu skrējējus, tostarp pārklājošos darbiniekus un atkārtotos darbus. Pārlūkprogrammas testos ir jāizmanto visa rediģēšanas darbplūsma ar katru lomu un tikai tastatūras izmantošanas priekšgals.

Izlaidums ar konfigurācijas pārvaldību, atjaunināšanas āķiem, akreditācijas datu rotāciju, rindu informācijas paneļiem, neveiksmīgu darbu atkārtošanu, žurnāla minimizēšanu, datu bāzes dublēšanu un atcelšanas izpildgrāmatu. Importējiet konfigurāciju produkcijai līdzīgā vidē un apstipriniet, ka esošie komplekti, tulkojumi, atļaujas un skati paliek neskarti. Pieņemšana ietver iepriekšējās apstiprinātās versijas atjaunošanu, kešatmiņu un indeksu atjaunošanu un apstiprināšanu, ka publiskie URL un audita ieraksti paliek pareizi.

Lomas, pierādījumi un apstiprinājums

Saglabājiet ģenerēšanu atsevišķi no publikācijas. Veiksmīga atbilde ir melnraksts, nevis apstiprinājums. Saglabājiet avota identifikatoru un versiju, transformācijas iestatījumus, rezultāta identifikatoru, pārskatīšanas stāvokli, apstiprinātāju un publicēšanas laiku. Kad avots mainās, atzīmējiet valodas versiju pārskatīšanai, nevis klusi nomainiet apstiprināto saturu. Tas padara iespējamu atcelšanu un auditu visās platformās.

Darbības un apkope

Darbs nebeidzas ar publicēšanu. Saistiet valodas versiju vai konfigurāciju ar tās avotu, uzraugiet kvalitātes un pakalpojumu pasākumus un definējiet konkrētus pārskatīšanas aktivizētājus. Aktivizētāji ietver avota izmaiņas, juridiskās izmaiņas, jaunas auditorijas vajadzības, periodiskus atbalsta jautājumus, tehniskas izmaiņas un incidentus. Nosaukts īpašnieks novērtē aktivizētāju, vajadzības gadījumā atver jaunu versiju un reģistrē atjaunoto apstiprinājumu.

Publicēšanas kontrolsaraksts

  • Integrācija izmanto noturīgus avota identifikatorus.

  • Akreditācijas dati tiek saglabāti servera pusē un pagriezti.

  • Noildze, atkārtots mēģinājums un ātruma ierobežojuma darbība ir definēta.

  • Atkārtoti pieprasījumi ir idempotenti.

  • Ģenerētais saturs nonāk pārskatīšanas stāvoklī.

  • Avota izmaiņas padara versiju nederīgu vai atkārtoti atver versiju.

  • Valodu navigācija darbojas, izmantojot tastatūru un palīgtehnoloģijas.

  • Uzraudzība attiecas uz kļūmēm, rindām, latentumu un novecojušu saturu.

Autoritatīvi avoti

  1. Simple8 API dokumentācija
  2. Simple8 piegādes modeļi
  3. Tīmekļa satura pieejamības vadlīnijas (WCAG) 2.2

Izmantojiet rokasgrāmatu praksē

Pārbaudiet Simple8 ar reprezentatīvu saturu un izmantojiet kontrolsarakstu, lai plānotu kontrolētu ražošanas darbplūsmu.

Pārbaudi savu tekstu