CMS és API

Drupal megvalósítási útmutató.

Használja a Drupal verziókat, a tartalom moderálását és az engedélyeket a generálás, a szakértői felülvizsgálat és a közzététel elkülönítésére.

Tisztázza a feladatot és a döntést

Ez az útmutató a drupal megvalósítási útmutatót egy áttekinthető működési munkafolyamattá alakítja. Összeköti a tartományi döntéseket, a tulajdonjogot, a bizonyítékokat és az elfogadást, így az eredmény továbbra is működik a termelésben.

Használja a Drupal verziókat, a tartalom moderálását és az engedélyeket a generálás, a szakértői felülvizsgálat és a közzététel elkülönítésére.

Gyakorlati munkafolyamat

  1. 1

    A készletforrás típusai, azonosítói, mezői, területei, tulajdonosai és közzétételi állapotai.

  2. 2

    Válassza ki a kézbesítési mintát a mennyiség, a várakozási idő, a szerkesztői vezérlés és a hibatűrés közül.

  3. 3

    A forrásrekord hozzárendelése egy különálló nyelvi verziójú rekordhoz tartós csatolással.

  4. 4

    Adjon hozzá hitelesítést, idempotenciát, újrapróbálkozást, gyorsítótár érvénytelenítését, naplózást és hozzáférés-vezérlést.

  5. 5

    Tesztközzététel, forrásmódosítások, nem elérhető eredmények, visszaállítás, billentyűzetkezelés és figyelés a kiadás előtt.

Példa vagy eszköz

A moderált tartalomtípus mezőket, szerepköröket, változatokat, kézbesítést és visszaállítást jelenít meg. Az eszközben rögzítse az alapállapotot, a tulajdonost, a döntést, a bizonyítékot, a nyitott kiadást és a jóváhagyás dátumát is. Valódi oldalt vagy tranzakciót használjon, hogy a csapat láthassa a függőségeket, a kivételeket és a kiadást követő karbantartási munkát.

Döntési pontRekordElfogadási kritérium
AlapvonalMegfigyelt jelenlegi állapotA felvétel forrása és dátuma
DöntésA kiválasztott lehetőség és indoklásFigyelembe vették a kockázatot és a közönséget
BizonyítékTeszteljen, dokumentáljon vagy mérjenÁttekinthető és verzióspecifikus
JóváhagyásNév, szerep és dátumMinden kötelező kritérium teljesült

Hozzon létre egy tartalmi modellt, amely megőrzi a származást

Hozzon létre egy hozzáférhető nyelvű tartalomtípust vagy egy strukturált entitást a hiteles forrásra mutató entitáshivatkozással. Tartalmazza a forrásváltozat azonosítóját, a nyelvi beállítást, a nyelvi módot, az eredményazonosítót, az ellenőrzés állapotát, a szószedet verzióját, a kockázati szintet, a jóváhagyókat és a következő felülvizsgálati szabályt. Használjon bekezdéseket vagy strukturált mezőket címsorokhoz, listákhoz, hivatkozásokhoz, értesítésekhez, letöltésekhez és kapcsolatfelvételi adatokhoz. Egyetlen korlátlan rich-text mező megnehezíti a mezőszintű érvényesítést, újrafelhasználást és biztonságos megjelenítést.

Szándékosan válasszon a Drupal fordítási relációja és egy külön kapcsolódó entitás között. A szabványos fordítás akkor működik, ha a mezőstruktúra és a szerkesztői életciklus egyenértékű marad. Egy külön entitás biztonságosabb, ha az elérhető verzió egyesíti, átrendezi vagy elmagyarázza a forrásmezőket, és eltérő moderálást igényel. Mindkét esetben ne változtassa meg a forrásváltozatot az átalakításhoz, és jelenítse meg az elavult állapotot, ha az aktuális forrás már nem egyezik vele.

Tervezési választásHasználja mikorSzükséges biztosíték
Tartalom fordításaA szerkezet és az életciklus egyenértékű maradA lektorált fordítás érintett, és a moderálás tesztelve
Kapcsolódó entitásA szerkezet, a tulajdonjog vagy az értékelés eltérőExplicit forráshivatkozás és kölcsönös navigáció
BekezdésleképezésA forrás újrafelhasználható strukturált blokkokat tartalmazNem támogatott kötegblokkok vagy jelzők generálása

Külön alkotás, szakvélemény és publikálás

A tartalommoderálási állapotok konfigurálása, például kért, generálás, vázlat, tárgy felülvizsgálat, nyelvi felülvizsgálat, jóváhagyott, közzétett, elavult és sikertelen. Határozza meg az átmeneteket a dedikált szerepkörökhöz, és ellenőrizze azokat a Drupal engedélyekkel és hozzáférés-kezelőkkel. A API integrációs fiók létrehozhat és frissíthet vázlatot, de nem hagyhatja jóvá vagy közzéteheti. Az alany felülvizsgálója nem hagyhatja jóvá saját magas kockázatú generációját, hacsak a dokumentált kockázati politika ezt meg nem engedi.

Engedélyezze a revíziókat, és biztosítsa, hogy minden átalakítás, megjegyzésfeloldás, állapotátmenet és forrás-újrabázis hozzon létre egy változatot szerzővel és időbélyeggel. Hozzon létre egy áttekintési nézetet, amely megjeleníti a forrást és a piszkozatot, a különbségeket, a figyelmeztetéseket, a hivatkozásokat és a megjelenített eredményt. Ha a forrás megváltozik, jelölje meg megfelelően az aktív piszkozatot és a közzétett verziót, és blokkolja a közzétételt, amíg a bíráló meg nem szünteti az eltérést.

  1. 1

    Konfigurálja az entitásmezőket, az érvényesítést, a revíziókat és a forráskapcsolatot.

  2. 2

    Moderálási állapotok és szerepspecifikus átmenetek létrehozása.

  3. 3

    Piszkozat létrehozása egy korlátozott várólista dolgozón keresztül.

  4. 4

    Töltse ki a tárgyi és nyelvi áttekintéseket egy azonosított változaton.

  5. 5

    A forrástól a kiadásig terjedő ellenőrzési nyomvonal közzététele, indexelése és megőrzése.

Drupal gyorsítótárazhatósággal és sértetlen hozzáférhetőséggel szállítja

Csatoljon gyorsítótár-címkéket a forrásentitáshoz, a forrásváltozat kapcsolatához, a nyelvi entitáshoz, a hivatkozott bekezdésekhez és adathordozókhoz, a szószedet-konfigurációhoz és a megjelenítőhöz. Használjon gyorsítótár-kontextust a területi beállításokhoz és a jogos hozzáférési változatokhoz, de ne tegye a jóváhagyott nyilvános oldalakat a felhasználó-specifikus generálási állapottól függővé. Érvénytelenítse az érintett oldalakat az entitás módosításával vagy a várólista befejezésével, és az utolsó jóváhagyott változat látható maradjon a csere felülvizsgálata közben.

A nyelvi navigációt normál hivatkozásként jelenítse meg a Drupal útválasztáson és a nyelvtudatos URL-generáláson keresztül. Adjon hozzá kölcsönös forráshivatkozásokat, alternatív nyelvű metaadatokat, navigációs útvonalakat és webhelytérkép-bejegyzéseket. Ellenőrizze a címsor hierarchiáját, a hivatkozás célját, a fókusz sorrendjét, az állapotüzeneteket és az űrlaphiba-társítást a végső témában. Tisztítsa meg a API kimenetet a megengedett strukturált mezőkkel és a Drupal renderelő rendszerével. Soha ne jelölje biztonságosnak a generált HTML-t pusztán azért, mert megbízható szerverről származik.

  • A gyorsítótár-címkék lefedik a forrást, a nyelvi verziót, az összetevőket, a médiát, a szószedet és a megjelenítőt.

  • A várakozási sor feldolgozása nem tehet közzé tartalmat, és nem törölheti idő előtt az utolsó jóváhagyott eredményt.

  • A nyelvi útvonalak és a forráshivatkozások JavaScript nélkül működnek.

  • A szövegformátumok és a megjelenítési tömbök megakadályozzák a nem biztonságos jelöléseket.

  • A keresés csak a jóváhagyott változatot indexeli, és eltávolítja a visszavont útvonalakat.

Igazolja az engedélyeket, a revíziókat és a visszaállításokat

A kernel- és funkcionális teszteknek ki kell terjedniük a mező érvényesítésére, a hozzáférés-vezérlésre, a moderálási átmenetekre, a revíziók létrehozására, az elavult forrás észlelésére, a sor újrapróbálására, a gyorsítótár érvénytelenítésére, az útvonal-hozzáférésre és az összes támogatott összetevő megjelenítésére. Tesztelje a Drupal cron és a külső sorfutókat, beleértve az átfedő dolgozókat és az ismétlődő feladatokat. A böngészőteszteknek a teljes szerkesztői munkafolyamatot kell végrehajtaniuk minden szerepkörrel és csak a billentyűzettel végzett frontend használattal.

Kiadás konfigurációkezeléssel, frissítési hook-okkal, hitelesítő adatok elforgatásával, sor-irányítópultokkal, sikertelen feladatok újrajátszásával, naplózás minimalizálásával, adatbázis-mentéssel és visszaállítási runbook-val. Importálja a konfigurációt egy éles környezetbe, és ellenőrizze, hogy a meglévő csomagok, fordítások, engedélyek és nézetek érintetlenek maradnak. Az elfogadás magában foglalja egy korábbi jóváhagyott változat visszaállítását, a gyorsítótárak és indexek újraépítését, valamint annak megerősítését, hogy a nyilvános URL-ek és a megfigyelési rekordok helyesek maradnak.

Szerepek, bizonyítékok és jóváhagyás

A generálást tartsa külön a közzétételtől. A sikeres válasz tervezet, nem jóváhagyás. Tárolja a forrásazonosítót és verziót, az átalakítási beállításokat, az eredményazonosítót, a felülvizsgálati állapotot, a jóváhagyót és a közzétételi időt. Amikor a forrás megváltozik, a jóváhagyott tartalom csendes cseréje helyett jelölje meg a nyelvi verziót felülvizsgálatra. Ez lehetővé teszi a visszaállítást és az auditálást a platformok között.

Műveletek és karbantartás

A munka nem ér véget a megjelenéssel. Kapcsolja össze a nyelvi verziót vagy konfigurációt a forrásával, figyelje a minőségi és szolgáltatási intézkedéseket, és határozzon meg konkrét felülvizsgálati indítékokat. A kiváltó tényezők közé tartoznak a forrásváltozások, a jogi változások, az új közönségigények, az ismétlődő támogatási kérdések, a technikai változások és az incidensek. Egy megnevezett tulajdonos értékeli az eseményindítót, szükség esetén új verziót nyit meg, és rögzíti a megújított jóváhagyást.

Közzétételi ellenőrzőlista

  • Az integráció tartós forrásazonosítókat használ.

  • A hitelesítő adatokat a rendszer a szerver oldalon tárolja és elforgatja.

  • Meg van határozva az időtúllépés, az újrapróbálkozás és a sebességkorlátozás viselkedése.

  • Az ismételt kérések idempotensek.

  • A generált tartalom felülvizsgálati állapotba kerül.

  • A forrásmódosítások érvénytelenítik vagy újra megnyitják a verziót.

  • A nyelvi navigáció billentyűzettel és kisegítő technológiával működik.

  • A figyelés kiterjed a hibákra, a várólistákra, a várakozási időre és az elavult tartalomra.

Hiteles források

  1. Simple8 API dokumentáció
  2. Simple8 szállítási minták
  3. Webes tartalom hozzáférhetőségi irányelvei (WCAG) 2.2

Alkalmazza az útmutatót a gyakorlatban

Tesztelje a Simple8-t reprezentatív tartalommal, és használja az ellenőrzőlistát egy ellenőrzött gyártási munkafolyamat megtervezéséhez.

Teszteld a saját szövegedet