CMS и API

Ръководство за внедряване на WordPress.

Изберете съзнателно джаджа или доставка на API, поддържайте оригиналната страница канонична и публикувайте езикови версии чрез ревизии.

Изяснете задачата и решението

Това ръководство превръща ръководството за внедряване на wordpress в прегледен оперативен работен процес. Той свързва решения за домейн, собственост, доказателства и приемане, така че резултатът да продължи да работи в производството.

Изберете съзнателно джаджа или доставка на API, поддържайте оригиналната страница канонична и публикувайте езикови версии чрез ревизии.

Практически процес

  1. 1

    Типове източници на инвентаризация, идентификатори, полета, локали, собственици и състояния на публикация.

  2. 2

    Изберете модела на доставка от обем, латентност, редакционен контрол и толерантност на отказ.

  3. 3

    Съпоставете изходния запис към отделен запис на езикова версия с трайна връзка.

  4. 4

    Добавете удостоверяване, идемпотентност, повторен опит, анулиране на кеша, регистриране и контроли за достъп.

  5. 5

    Тестова публикация, промени в източника, недостъпни резултати, връщане назад, работа с клавиатура и наблюдение преди пускане.

Пример или инструмент

Работният процес на Gutenberg картографира изходните страници, състоянията на прегледа, ключовете на кеша и езиковата навигация. В инструмента запишете също базовата линия, собственика, решението, доказателствата, отворения проблем и датата на одобрение. Използвайте реална страница или транзакция, така че екипът да види зависимости, изключения и работата по поддръжката, която следва освобождаването.

Точка на решениеЗаписвайтеКритерий за приемане
Базово нивоНаблюдавано текущо състояниеИзточник и дата на запис
РешениеИзбран вариант и обосновкаОбмислени риск и аудитория
ДоказателствоТествайте, документирайте или измервайтеВъзможност за преглед и специфична за версията
ОдобрениеИме, роля и датаСпазени всички задължителни критерии

Изберете джаджа, плъгин или API доставка от страна на сървъра

Използвайте приспособление, когато скоростта на внедряване има значение, изходните страници вече имат трайни идентификатори и зависимостта от страна на клиента е приемлива. Използвайте приставка WordPress, когато редакторите се нуждаят от генериране и преглед в административния интерфейс. Използвайте API доставка от страна на сървъра, когато езиковите версии трябва да бъдат индексирани, кеширани, включени в емисии и изобразени дори когато JavaScript не е наличен. Големите издатели често комбинират плъгин за работен процес с изобразяване от страна на сървъра за доставка.

Документирайте избора срещу редакционен контрол, производителност, достъпност, търсене, поведение при отказ, поток от данни и собственост върху поддръжката. Оригиналната страница остава авторитетен източник. Езиковата версия получава собствена публикация или структуриран запис, стабилен URL адрес, статус на преглед и връзка към ревизия на източника. Избягвайте да съхранявате алтернативно съдържание само в неверсирано персонализирано поле или кеш на браузъра, тъй като рецензентите не могат надеждно да го одобрят, възстановят или одитират.

МоделНай-добро приляганеПървичен контрол
WidgetБързо добавяне към контролиран сайтДостъпно резервно състояние и състояние на повреда
Работен процес на приставкатаРедакторите работят изцяло в WordPressРоли, nonces, възможности и ревизии
API от страна на сървъраИндексирани, кеширащи, устойчиви странициОпашка, анулиране на кеша и операции по внедряване

Моделирайте връзките на източника и редакционните състояния

Създайте тип публикация на езикова версия или използвайте многоезична структура, която поддържа изрични връзки на източника. Идентификатор на публикацията на източника, ИД на изходната версия, целеви локал, езиков режим, ИД на резултата, версия на речника, статус на преглед, одобряващи, публикувана версия и тригер за преглед. Запазете трансформираната блокова структура, където е възможно, така че заглавията, списъците, връзките, таблиците и забележките да останат семантични, вместо да бъдат сплеснати в едно HTML поле.

Дефинирайте статуси за заявено, генериране, чернова, преглед на предмета, преглед на езика, одобрен, публикуван, остарял и неуспешен. Съпоставете всеки преход към възможност на WordPress, а не само към видим бутон. Генераторът може да създаде чернова, но не може да я одобри. Когато източникът се промени, сравнете неговата версия с одобрената версия на източника и преместете езиковата версия на остаряла или се изисква преглед. Не публикувайте тихо регенериран резултат.

  1. 1

    Регистрирайте записа на езиковата версия и необходимите метаданни с разрешения за дезинфекция и REST.

  2. 2

    Картирайте поддържаните блокове на Gutenberg и дефинирайте поведението за неподдържаните блокове.

  3. 3

    Конфигуриране на роли и разрешени преходи на статуси.

  4. 4

    Генерирайте в отделна ревизия и представете сравнение на източника.

  5. 5

    Публикувайте само след необходимите одобрения за нивото на риск за съдържанието.

Кеширайте безопасно и осигурете трайна езикова навигация

Създайте кеш ключове от сайта, ID на изходната публикация, редакция на изходния код, локал, езиков режим и версия на рендера. Невалидност на свързаната езикова страница, когато нейната одобрена редакция се промени, нейният източник се промени, споделен блок се промени или подходящо терминологично правило се публикува повторно. Ако обработката протича асинхронно, подайте последната одобрена версия, докато новата чернова се преглежда. Никога не замествайте одобреното съдържание с празно състояние, защото генерирането не е налично.

Добавете езикови връзки като обикновени рендирани от сървъра котви с ясни имена като „ясен език“ и „лесен за четене текст“. Включете реципрочни връзки към изходната страница и правилни метаданни на алтернативен език. Запазете фокуса на клавиатурата след превключване в страницата и обявете промяна на маршрута само чрез нормалното заглавие и заглавие на страницата. Липсваща версия трябва да обясни, че не е налична и да се свърже обратно към източника, а не да скрие контролата или да се върне безшумно.

  • Ключовете за кеша включват версии на източника и рендера.

  • Последната одобрена страница преживява API и прекъсвания на опашката.

  • Езиковите връзки работят без JavaScript и използват одобрена терминология.

  • Каноничните и алтернативните метаданни отразяват действителната връзка.

  • Промените в споделения блок и речника задействат засегнатите задачи за преглед.

Тествайте пълния път на публикуване и връщане назад

Използвайте сценично копие с представителни блокове на Gutenberg, потребителски полета, вградени формуляри, блокове за многократна употреба и ограничени публикации. Генериране на тестове, налагане на роли, преглед на коментари, планирано публикуване, визуализация, анулиране на кеша, актуализация на източника, остаряло маркиране, изтриване, възстановяване и връщане назад. Потвърдете, че крайните точки на REST отхвърлят неупълномощено четене и запис и че фоновите задания не могат да бъдат задействани между сайтове без валидни идентификационни данни за nonce или сървър.

Преди производството дефинирайте наблюдение на опашката, собственост върху грешката, ротация на идентификационни данни, тестване на актуализацията на плъгина, архивиране на база данни и процедура за безопасно деактивиране. Приемането изисква правилно изобразяване на общи точки на прекъсване, навигация с клавиатура и екранен четец, без изместване на оформлението от късно съдържание, валидни структурирани заглавия, проследимо одобрение и възстановяване на последната одобрена редакция. Запишете поддържаните WordPress, PHP, редактор, многоезичен плъгин и конфигурации за кеширане.

Роли, доказателства и одобрение

Съхранявайте генерирането отделно от публикуването. Успешният отговор е чернова, а не одобрение. Съхранявайте идентификатора на източника и версията, настройките за трансформация, идентификатора на резултата, състоянието на прегледа, одобряващия и времето за публикуване. Когато източникът се промени, маркирайте езиковата версия за преглед, вместо тихо да замествате одобреното съдържание. Това прави възможно връщане назад и одит на различни платформи.

Експлоатация и поддръжка

Работата не приключва с публикуването. Свържете езиковата версия или конфигурация с нейния източник, наблюдавайте мерките за качество и обслужване и дефинирайте конкретни тригери за преглед. Задействанията включват промени в източника, правни промени, нови нужди на аудиторията, повтарящи се въпроси за поддръжка, технически промени и инциденти. Посочен собственик оценява тригера, отваря нова ревизия, когато е необходимо, и записва подновено одобрение.

Контролен списък за публикуване

  • Интеграцията използва трайни идентификатори на източника.

  • Идентификационните данни се съхраняват от страната на сървъра и се сменят.

  • Дефинирани са изчакване, повторен опит и поведение при ограничаване на скоростта.

  • Повтарящите се искания са идемпотентни.

  • Генерираното съдържание влиза в състояние на преглед.

  • Промените в източника обезсилват или отварят отново версията.

  • Езиковата навигация работи с клавиатура и помощна технология.

  • Мониторингът обхваща повреди, опашки, забавяне и остаряло съдържание.

Авторитетни източници

  1. Simple8 API документация
  2. Simple8 модели на доставка
  3. Насоки за достъпност на уеб съдържание (WCAG) 2.2

Приложете ръководството на практика

Тествайте Simple8 с представително съдържание и използвайте контролния списък, за да планирате контролиран производствен процес.

Тествайте своя собствен текст