CMS un API

TYPO3 ieviešanas rokasgrāmata.

Modelējiet pieejamās valodas versijas kā pārvaldītus ierakstus, kas saistīti ar to avota saturu un darbvietas apstiprinājumu.

Noskaidrojiet uzdevumu un lēmumu

Šī rokasgrāmata pārvērš typo3 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ā.

Modelējiet pieejamās valodas versijas kā pārvaldītus ierakstus, kas saistīti ar to avota saturu un darbvietas apstiprinājumu.

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

TYPO3 darbvietas piemērs aptver lauka kartēšanu, tulkošanas attiecības, izvietošanu un atzīšanu par nederīgu. 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

Modeļa valodu versijas kā reglamentēti ieraksti

Izmantojiet īpašu satura ierakstu vai lapas veidu pieejamās valodas versijai un savienojiet to ar avotu ar nemainīgu saistību. Veikala avota UID, avota darbvietas pārskatīšana vai satura jaukšana, mērķa lokalizācija, valodas režīms, transformācijas rezultāta ID, pārskatīšanas stāvoklis, glosārija versija, apstiprinātāji un pēdējais verifikācijas datums. Saglabājiet šīs attiecības atsevišķi no TYPO3 parastās lokalizācijas tulkošanas attiecības, kad versija maina struktūru vai informācijas blīvumu, nevis tikai valodu.

Apzināti kartējiet strukturētus avota laukus. Saglabājiet virsrakstus, rindkopas, sarakstus, saites, tabulas, paziņojumus, lejupielādes un kontaktu blokus kā semantiskos elementus. Definējiet drošu atkāpšanos katram neatbalstītajam satura elementam: saglabājiet to ar pārskatītāja brīdinājumu, aizstājiet to ar apstiprinātu kopsavilkuma komponentu vai bloķējiet ģenerēšanu. Nekad nenometiet nezināmu elementu klusi. Failu atsauces un saites saglabā savus identifikatorus, lai validācija varētu noteikt mainītās vai dzēstās atkarības.

Ieraksta lauksMērķisNepieciešamā uzvedība
avots_uidSavieno versiju un avotuNemaināma saistība ar atļauju pārbaudi
avots_pārskatīšanaAtklāj avota izmaiņasAtzīmē apstiprinātu versiju pārskatīšanai, ja tā atšķiras
pārskatīšanas_stāvoklisKontrolē darbplūsmuPāreju ierobežo aizmugursistēmas loma
rezultātu_idAtbalsta izsekojamībuSaglabāts ar iestatījumiem un pieprasījuma laiku

Izmantojiet darbvietas ģenerēšanai, pārskatīšanai un apstiprināšanai

Izveidojiet ģenerēto rezultātu kontrolētā darbvietā, nevis tieši tiešajā darbvietā. Paaudzes loma var pieprasīt un atjaunināt melnrakstus. Priekšmeta pārskatītājs apstiprina nosacījumus, skaitļus, datumus, pienākumus un saites. Valodas pārskatītājs pārbauda atlasīto režīmu un renderēto braucienu. Izdevējs pārbauda atrisinātos atradumus un pārvieto apstiprināto versiju noteiktā darbvietas posmā. Ieviesiet šīs iespējas aizmugursistēmas atļaujās un servera puses pārejas loģikā.

Konfigurējiet posma paziņojumus ar ieraksta URL, avota pārskatīšanu, riska līmeni, nepieciešamo lomu un izpildes datumu. Recenzentiem ir nepieciešama nozīmīga atšķirība, kas atšķir satura izmaiņas no TYPO3 metadatu trokšņa. Ja avots tiek rediģēts, kamēr pārskatīšana ir atvērta, atzīmējiet versiju, kas ir novecojusi, un pieprasiet komandai izvēlēties starp melnraksta bāzes atjaunošanu vai skaidri ierakstīta izņēmuma pabeigšanu. Sistēmai ir jānovērš novecojuša apstiprinājuma pieejamība tiešraidē.

  1. 1

    Izveidojiet vai identificējiet avota ierakstu un tveriet tā darbvietas pārskatīšanu.

  2. 2

    Ģenerējiet strukturēto versiju piešķirtajā darbvietā.

  3. 3

    Pabeidziet priekšmeta, valodas un saites validāciju renderētajā priekšskatījumā.

  4. 4

    Atrisiniet konstatējumus un apstipriniet, ka avota pārskatīšana joprojām ir aktuāla.

  5. 5

    Publicējiet apstiprināto ierakstu un saglabājiet visu darbvietas vēsturi.

Izvietojiet un padariet nederīgus, nezaudējot apstiprināto saturu

Izveidojiet maršruta uzlabotājus un lapu metadatus, kas katrai versijai nodrošina stabilu, lasāmu URL. Publicējiet savstarpējās valodu saites un kanoniskās attiecības servera renderētā marķējumā. Iekļaujiet versiju vietnes meklēšanā un XML vietņu kartēs tikai pēc apstiprināšanas. Skaidri konfigurējiet piekļuves ierobežojumus un pārbaudiet, vai publiskas valodas lapa nepārmanto netīšus avota lapas ierobežojumus un neatklāj aizsargātu avota saturu.

Ja tiek mainīta apstiprinātā versija, avots, atsauces fails, koplietotā satura elements, renderēšanas veidne vai glosārijs, nederīgi nosakiet pareizās priekšgala kešatmiņas. Izmantojiet kešatmiņas tagus, kas ietver gan avota, gan versijas identifikatorus. Ģenerēšanas vai pārskatīšanas laikā turpiniet apkalpot pēdējo apstiprināto ierakstu. Neveiksmīgs pieprasījums rada redzamu aizmugursistēmas uzdevumu un darbības notikumu, taču tas neiztīra derīgu publisko lapu vai neaizstāj to ar melnrakstu.

  • Katrai publiskajai versijai ir stabils maršruts un savstarpēja avota saite.

  • Meklēšana un vietnes karte ietver tikai apstiprinātus ierakstus.

  • Kešatmiņas tagi aptver avotu, versiju, koplietotos elementus, failus un renderētāju.

  • Aizsargātie avoti nevar izplūst caur ģenerētajiem publiskajiem ierakstiem.

  • Pēdējais apstiprinātais ieraksts paliek pieejams kļūmju un pārskatīšanas laikā.

Izmantojiet paplašinājumu, izmantojot TYPO3 jauninājumus

Pārbaudiet paplašinājumu pret atbalstītajām TYPO3 ilgtermiņa atbalsta versijām, PHP versijām, datu bāzi, daudzvalodu konfigurāciju, darbvietām, plānotāju, meklēšanas paplašinājumu un kešatmiņas slāni. Automatizētajos integrācijas testos jāietver aizmugursistēmas atļauju pārbaudes, DataHandler āķi, relāciju noturība, darbvietas pārejas, kešatmiņas nederīgums, API kļūme un novecojuša avota noteikšana. Pārlūkprogrammas testi aptver aizmugures tastatūras darbību un priekšgala navigāciju reprezentatīvā platumā.

Pirms izlaišanas dokumentējiet plānotāja darbus, rindu uzraudzību, akreditācijas datu rotāciju, žurnālu saglabāšanu, dublēšanu un atjaunošanu, shēmas migrāciju un droša paplašinājuma atspējošanu. Vispirms veiciet jaunināšanu ražošanai līdzīgai izlaiduma kopijai un pārbaudiet vecos apstiprinātos ierakstus pirms jaunu ierakstu izveides. Pieņemšana ietver gan paplašinājuma koda, gan datu bāzes migrācijas veiksmīgu atcelšanu, joprojām ir pieejams publicētais saturs un tā audita vēsture ir neskarta.

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