CMS és API

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

Szándékosan válasszon widget vagy API megjelenítést, tartsa gyűjtőként az eredeti oldalt, és tegye közzé a nyelvi változatokat a revíziók révén.

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

Ez az útmutató a wordpress 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.

Szándékosan válasszon widget vagy API megjelenítést, tartsa gyűjtőként az eredeti oldalt, és tegye közzé a nyelvi változatokat a revíziók révén.

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 Gutenberg-munkafolyamat leképezi a forrásoldalakat, az állapotokat, a gyorsítótár kulcsait és a nyelvi navigációt. 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

Válasszon widgetet, beépülő modult vagy szerveroldali API szállítást

Használjon widgetet, ha a telepítési sebesség számít, a forrásoldalak már rendelkeznek tartós azonosítókkal, és az ügyféloldali függőség is elfogadható. Használjon WordPress beépülő modult, ha a szerkesztőknek generálásra és felülvizsgálatra van szükségük az adminisztrációs felületen belül. Használja a szerveroldali API kézbesítést, ha a nyelvi verziókat indexelni, gyorsítótárazni, hírcsatornákban kell szerepeltetni, és akkor is megjeleníteni, ha a JavaScript nem érhető el. A nagy kiadók gyakran kombinálnak egy beépülő modult a munkafolyamathoz a szerveroldali megjelenítéssel a kézbesítéshez.

Dokumentálja a választást a szerkesztői ellenőrzés, a teljesítmény, a hozzáférhetőség, a keresés, a hibaviselkedés, az adatáramlás és a karbantartási tulajdonjog alapján. Az eredeti oldal marad a mérvadó forrás. A nyelvi változat saját bejegyzést vagy strukturált rekordot, stabil URL-t, felülvizsgálati állapotot és forrás-változat hivatkozást kap. Kerülje az alternatív tartalom csak verzió nélküli egyéni mezőben vagy a böngésző gyorsítótárában való tárolását, mert az ellenőrök nem tudják megbízhatóan jóváhagyni, visszaállítani vagy ellenőrizni.

MintaLegjobb illeszkedésElsődleges vezérlés
WidgetGyors kiegészítés egy ellenőrzött helyszínhezHozzáférhető tartalék és hibaállapot
Plugin munkafolyamatA szerkesztők teljes egészében a WordPress-ben működnekSzerepek, hiányosságok, képességek és revíziók
Szerveroldali APIIndexelt, gyorsítótárazható, rugalmas oldalakVárólista, gyorsítótár érvénytelenítése és telepítési műveletek

Forráskapcsolatok és szerkesztői állapotok modellezése

Hozzon létre egy nyelvi verziójú bejegyzéstípust, vagy használjon többnyelvű struktúrát, amely támogatja az explicit forráskapcsolatokat. Tárolja a forrásbejegyzés azonosítóját, a forrásváltozat azonosítóját, a célterületet, a nyelvi módot, az eredményazonosítót, a szószedet verzióját, az ellenőrzés állapotát, a jóváhagyókat, a közzétett változatot és a felülvizsgálati eseményindítót. Ha lehetséges, tartsa meg az átalakított blokkstruktúrát, hogy a címsorok, listák, hivatkozások, táblázatok és megjegyzések szemantikusak maradjanak, ahelyett, hogy egyetlen HTML-mezőbe lennének laposítva.

Határozza meg a kért, a generálás, a vázlat, a tárgy felülvizsgálata, a nyelvi felülvizsgálat, a jóváhagyott, a közzététel, az elavult és a sikertelen állapotokat. Minden átmenetet leképezhet egy WordPress képességgel, nem csupán egy látható gombbal. A generátor létrehozhat vázlatot, de nem hagyhatja jóvá. Amikor a forrás megváltozik, hasonlítsa össze a változatát a jóváhagyott forrásváltozattal, és helyezze át a nyelvi verziót elavulttá, vagy felülvizsgálatra van szükség. Ne tegyen közzé csendben egy újragenerált eredményt.

  1. 1

    Regisztrálja a nyelvi verzió rekordját és a szükséges metaadatokat fertőtlenítési és REST engedélyekkel.

  2. 2

    Térképezze fel a támogatott Gutenberg-blokkokat, és határozza meg a nem támogatott blokkok viselkedését.

  3. 3

    Szerepkörök és engedélyezett állapotátmenetek konfigurálása.

  4. 4

    Generáljon külön revíziót, és mutassa be a forrás-összehasonlítást.

  5. 5

    Csak a tartalomkockázati szint szükséges jóváhagyása után tegye közzé.

Biztonságosan gyorsítótárazzon, és tartós nyelvi navigációt biztosítson

Hozzon létre gyorsítótár-kulcsokat a webhelyből, a forrásbejegyzés azonosítójából, a forrásváltozatból, a területi beállításból, a nyelvi módból és a megjelenítő verziójából. Érvénytelenítse a kapcsolódó nyelvi oldalt, ha megváltozik a jóváhagyott változata, megváltozik a forrása, megváltozik egy megosztott blokk, vagy ha egy releváns terminológiai szabályt újra közzétesznek. Ha a feldolgozás aszinkron módon fut, az új vázlat felülvizsgálata közben szolgálja ki az utolsó jóváhagyott verziót. Soha ne cserélje ki a jóváhagyott tartalmat üres állapotra, mert a generálás nem érhető el.

Adjon hozzá nyelvi hivatkozásokat közönséges, szerver által megjelenített horgonyként, egyértelmű nevekkel, például „közérthető nyelv” és „könnyen érthető kommunikáció”. Tartalmazzon kölcsönös hivatkozásokat a forrásoldalra, és javítsa ki az alternatív nyelvű metaadatokat. Az oldalon belüli váltás után megőrizheti a billentyűzet fókuszát, és csak a normál oldalcímen és címsoron keresztül jelentheti be az útvonal módosítását. A hiányzó verziónak meg kell magyaráznia, hogy nem érhető el, és vissza kell mutatnia a forráshoz, nem pedig el kell rejtenie a vezérlőt, vagy csendben vissza kell lépnie.

  • A gyorsítótár-kulcsok forrás- és megjelenítőverziót tartalmaznak.

  • Az utolsó jóváhagyott oldal túléli a API és a sorkimaradásokat.

  • A nyelvi hivatkozások JavaScript nélkül működnek, és jóváhagyott terminológiát használnak.

  • A kanonikus és az alternatív metaadatok a tényleges kapcsolatot tükrözik.

  • A megosztott blokkok és a szószedet módosításai az érintett felülvizsgálati feladatokat váltják ki.

Tesztelje a teljes közzétételi és visszaállítási útvonalat

Használjon átmeneti példányt reprezentatív Gutenberg-blokkokkal, egyéni mezőkkel, beágyazott űrlapokkal, újrafelhasználható blokkokkal és korlátozott bejegyzésekkel. Tesztgenerálás, szerepkör érvényesítése, megjegyzések felülvizsgálata, ütemezett közzététel, előnézet, gyorsítótár érvénytelenítése, forrásfrissítés, elavult jelölés, törlés, visszaállítás és visszaállítás. Győződjön meg arról, hogy a REST-végpontok visszautasítják a jogosulatlan olvasásokat és írásokat, és hogy a háttérfeladatokat nem lehet elindítani a helyek között érvényes nonce vagy kiszolgáló hitelesítési adatok nélkül.

A gyártás előtt határozza meg a sor figyelését, a hiba tulajdonjogát, a hitelesítő adatok elforgatását, a beépülő modul frissítésének tesztelését, az adatbázis biztonsági mentését és a biztonságos letiltási eljárást. Az elfogadás megköveteli a helyes megjelenítést a gyakori töréspontokon, a billentyűzet és a képernyőolvasó navigációját, a késői tartalomtól való elrendezés eltolódásának tilalmát, az érvényes strukturált címsorokat, a nyomon követhető jóváhagyást és az utolsó jóváhagyott változat visszaállítását. Rögzítse a támogatott WordPress, PHP, szerkesztő, többnyelvű bővítmény és gyorsítótárazási konfigurációkat.

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