CMS ja API

Drupal toteutusopas.

Käytä Drupal-versioita, sisällön valvontaa ja käyttöoikeuksia luomisen, asiantuntija-arvioinnin ja julkaisun erottamiseen.

Selvitä tehtävä ja päätös

Tämä opas muuttaa drupal-toteutusoppaan tarkistettavaksi käyttötyönkuluksi. Se yhdistää verkkotunnuksen päätökset, omistajuuden, todisteet ja hyväksynnän, jotta tulos toimii edelleen tuotannossa.

Käytä Drupal-versioita, sisällön valvontaa ja käyttöoikeuksia luomisen, asiantuntija-arvioinnin ja julkaisun erottamiseen.

Käytännön työnkulku

  1. 1

    Varaston lähdetyypit, tunnisteet, kentät, alueet, omistajat ja julkaisutilat.

  2. 2

    Valitse toimitusmalli äänenvoimakkuuden, latenssin, toimituksellisen ohjauksen ja virhetoleranssin joukosta.

  3. 3

    Yhdistä lähdetietue erilliseksi kieliversiotietueeksi kestävällä linkityksellä.

  4. 4

    Lisää todennus, idempotenssi, uudelleenyritys, välimuistin mitätöinti, lokikirjaus ja pääsynhallinta.

  5. 5

    Testijulkaisu, lähdemuutokset, tulokset, joita ei ole saatavilla, palautus, näppäimistön käyttö ja valvonta ennen julkaisua.

Esimerkki tai työkalu

Valvottu sisältötyyppi näyttää kentät, roolit, versiot, toimituksen ja palautuksen. Tallenna työkaluun myös lähtökohta, omistaja, päätös, todisteet, avoin kysymys ja hyväksymispäivä. Käytä oikeaa sivua tai tapahtumaa, jotta tiimi näkee riippuvuudet, poikkeukset ja julkaisua seuraavat ylläpitotyöt.

PäätöskohtaTallentaaHyväksymiskriteeri
PerustasoHavaittu nykytilaLähde ja tallennuspäivämäärä
PäätösValittu vaihtoehto ja perustelutRiski ja yleisö huomioitu
TodisteetTestaa, dokumentoi tai mittaaTarkastettava ja versiokohtainen
HyväksyminenNimi, rooli ja päivämääräKaikki pakolliset kriteerit täyttyivät

Luo sisältömalli, joka säilyttää alkuperän

Luo esteettömän kielen sisältötyyppi tai strukturoitu kokonaisuus, jossa on entiteettiviittaus luotettavaan lähteeseen. Sisällytä lähteen versiotunnus, alue, kielitila, tulostunnus, tarkistuksen tila, sanaston versio, riskitaso, hyväksyjät ja seuraavan tarkistuksen laukaisin. Käytä kappaleita tai jäsenneltyjä kenttiä otsikoille, luetteloille, linkeille, huomautuksille, latauksille ja yhteystiedoille. Yksi rajoittamaton rich-text-kenttä tekee kenttätason validoinnista, uudelleenkäytöstä ja turvallisesta hahmontamisesta vaikeampaa.

Valitse tietoisesti Drupal:n käännössuhteen ja erillisen siihen liittyvän entiteetin välillä. Vakiokäännös toimii, kun kentän rakenne ja toimituksellinen elinkaari pysyvät vastaavina. Erillinen kokonaisuus on turvallisempi, kun saavutettavissa oleva versio yhdistää, järjestää uudelleen tai selittää lähdekenttiä ja tarvitsee erilaista valvontaa. Kummassakin tapauksessa pidä lähdeversio muuttumattomana muunnokselle ja näytä vanhentunut tila, kun nykyinen lähde ei enää vastaa sitä.

Suunnittelun valintaKäytä milloinVaadittu suoja
Sisällön käännösRakenne ja elinkaari pysyvät samanarvoisinaVersion käännös vaikuttaa ja moderointi on testattu
Asiaan liittyvä tahoRakenne, omistajuus tai arvostelu vaihtelevatSelkeä lähdeviittaus ja vastavuoroinen navigointi
Kappaleen kartoitusLähde sisältää uudelleenkäytettäviä strukturoituja lohkojaEi-tuettu nippulohkojen tai lippujen luominen

Erillinen luominen, asiantuntija-arvio ja julkaisu

Määritä sisällönvalvontatilat, kuten pyydetty, luotava, luonnos, aiheen tarkistus, kielitarkistus, hyväksytty, julkaistu, vanhentunut ja epäonnistunut. Määritä siirtymät omistetuille rooleille ja vahvista ne Drupal-oikeuksilla ja pääsykäsittelijöillä. API-integraatiotili voi luoda ja päivittää luonnoksen, mutta ei voi hyväksyä tai julkaista. Aihearvioija ei voi hyväksyä omaa korkean riskin sukupolvea, ellei dokumentoitu riskipolitiikka salli sitä.

Ota versiot käyttöön ja varmista, että jokainen muunnos, kommenttien ratkaisu, tilasiirtymä ja lähteen uudelleenpohja luo version, jossa on tekijä ja aikaleima. Luo tarkistusnäkymä, jossa näkyy lähde ja luonnos, erot, varoitukset, linkit ja renderöity tulos. Jos lähde muuttuu, merkitse aktiivinen luonnos ja julkaistu versio asianmukaisesti ja estä julkaiseminen, kunnes tarkistaja korjaa ristiriidan.

  1. 1

    Määritä entiteettikentät, vahvistus, versiot ja lähdesuhde.

  2. 2

    Luo moderointitiloja ja roolikohtaisia ​​siirtymiä.

  3. 3

    Luo luonnos rajoitetun jonotyöntekijän kautta.

  4. 4

    Täytä aihe- ja kielikatsaukset yhdestä tunnistetusta versiosta.

  5. 5

    Julkaise, indeksoi ja säilytä kirjausketju lähteestä julkaisuun.

Toimita Drupal-välimuistin ja saavutettavuuden kanssa

Liitä välimuistitunnisteet lähdeentiteetille, lähdeversiosuhteelle, kielikokonaisuudelle, viitatuille kappaleille ja medialle, sanastokokoonpanolle ja renderöijalle. Käytä välimuistikonteksteja maa-asetuksille ja kaikille laillisille käyttöoikeusmuunnelmille, mutta älä aseta hyväksyttyjä julkisia sivuja riippuvaiseksi käyttäjäkohtaisesta luontitilasta. Mitätöi sivut, joita asia koskee, entiteetin muutoksilla tai jonon täydentämisellä ja pidä viimeisin hyväksytty versio näkyvissä, kun vaihtoa tarkistetaan.

Näytä kielinavigointi tavallisina linkkeinä Drupal-reitityksen ja kielitietoisen URL-osoitteen luomisen avulla. Lisää vastavuoroisia lähdelinkkejä, vaihtoehtoisen kielen metatietoja, navigointipolkuja ja sivustokarttamerkintöjä. Tarkista otsikkohierarkia, linkin tarkoitus, kohdistusjärjestys, tilaviestit ja lomakevirheyhteys lopullisessa teemassa. Puhdista API-tulostus sallittujen strukturoitujen kenttien ja Drupal:n renderöintijärjestelmän avulla. Älä koskaan merkitse luotua HTML-koodia turvalliseksi vain siksi, että se tuli luotetulta palvelimelta.

  • Välimuistitunnisteet kattavat lähteen, kieliversion, komponentit, median, sanaston ja renderöijän.

  • Jonokäsittely ei voi julkaista sisältöä tai tyhjentää viimeistä hyväksyttyä tulosta ennenaikaisesti.

  • Kielireitit ja lähdelinkit toimivat ilman JavaScriptiä.

  • Tekstimuodot ja renderöintitaulukot estävät vaarallisen merkinnän.

  • Haku indeksoi vain hyväksytyn version ja poistaa käytöstä poistetut reitit.

Todista käyttöoikeudet, versiot ja palautukset

Ytimen ja toiminnallisten testien tulee kattaa kentän validointi, pääsynvalvonta, moderointisiirtymät, versioiden luominen, vanhentuneen lähteen havaitseminen, jonojen uudelleenyritykset, välimuistin mitätöiminen, reitityskäyttö ja kaikkien tuettujen komponenttien renderöinti. Testaa Drupal cron ja ulkoiset jonon juoksijat, mukaan lukien päällekkäiset työntekijät ja toistuvat työt. Selaintestien tulee harjoittaa täydellistä toimituksellista työnkulkua jokaisen roolin ja vain näppäimistön käyttöliittymän yhteydessä.

Julkaisu, jossa on kokoonpanon hallinta, päivityskoukut, tunnistetietojen kierto, jonojen hallintapaneelit, epäonnistuneiden töiden toisto, lokin minimointi, tietokannan varmuuskopiointi ja palautuskirja. Tuo kokoonpano tuotantokaltaiseen ympäristöön ja varmista, että olemassa olevat paketit, käännökset, käyttöoikeudet ja näkymät pysyvät ennallaan. Hyväksymiseen sisältyy edellisen hyväksytyn version palauttaminen, välimuistien ja hakemistojen uudelleenrakentaminen sekä julkisten URL-osoitteiden ja tarkastustietueiden oikeellisuuden vahvistaminen.

Roolit, todisteet ja hyväksyntä

Pidä sukupolvi erillään julkaisusta. Onnistunut vastaus on luonnos, ei hyväksyntä. Tallenna lähteen tunniste ja versio, muunnosasetukset, tuloksen tunniste, tarkistuksen tila, hyväksyjä ja julkaisuaika. Kun lähde muuttuu, merkitse kieliversio tarkistettavaksi sen sijaan, että korvaisit hyväksytyn sisällön hiljaa. Tämä mahdollistaa palautuksen ja tarkastuksen eri alustoilla.

Käyttö ja huolto

Työ ei lopu julkaisuun. Linkitä kieliversio tai kokoonpano sen lähteeseen, seuraa laatu- ja palvelutoimenpiteitä ja määritä konkreettisia tarkistuskäynnistimiä. Triggereitä ovat lähteen muutokset, lakimuutokset, uudet yleisötarpeet, toistuvat tukikysymykset, tekniset muutokset ja tapaukset. Nimetty omistaja arvioi triggerin, avaa tarvittaessa uuden version ja kirjaa uusitun hyväksynnän.

Julkaisun tarkistuslista

  • Integraatiossa käytetään kestäviä lähdetunnisteita.

  • Tunnistetiedot tallennetaan palvelinpuolelle ja niitä kierretään.

  • Aikakatkaisu, uudelleenyritys ja nopeusrajoitus on määritelty.

  • Toistuvat pyynnöt ovat idempotentteja.

  • Luotu sisältö siirtyy tarkistustilaan.

  • Lähteen muutokset mitätöivät version tai avaavat sen uudelleen.

  • Kielinavigointi toimii näppäimistön ja aputekniikan avulla.

  • Valvonta kattaa viat, jonot, latenssin ja vanhentuneen sisällön.

Luotettavat lähteet

  1. Simple8 API -asiakirjat
  2. Simple8 toimitustavat
  3. Verkkosisällön saavutettavuusohjeet (WCAG) 2.2

Ota opas käyttöön

Testaa Simple8:tä edustavalla sisällöllä ja käytä tarkistuslistaa hallitun tuotannon työnkulun suunnitteluun.

Testaa omaa tekstiäsi