CMS и API

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

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

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

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

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

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

  1. 1

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

  2. 2

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

  3. 3

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

  4. 4

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

  5. 5

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

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

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

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

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

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

Изберете съзнателно между връзката на превод на Drupal и отделен свързан обект. Стандартният превод работи, когато структурата на полето и редакционният жизнен цикъл остават еквивалентни. Отделен обект е по-безопасен, когато достъпната версия комбинира, пренарежда или обяснява полетата на източника и се нуждае от различно модериране. И в двата случая запазете ревизията на източника неизменна за трансформацията и покажете остаряло състояние, когато текущият източник вече не съответства на него.

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

Отделно създаване, преглед от специалист и публикуване

Конфигурирайте състояния на модериране на съдържанието като заявено, генериране, чернова, преглед на предмета, преглед на езика, одобрено, публикувано, остаряло и неуспешно. Дефинирайте преходи за специални роли и ги проверете с Drupal разрешения и манипулатори за достъп. Акаунтът за интегриране на API може да създава и актуализира чернова, но не може да одобрява или публикува. Рецензент на обект не може да одобри собственото си високорисково генериране, освен ако документираната политика за риска не го позволява.

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

  1. 1

    Конфигурирайте полета на обекти, валидиране, ревизии и връзка с източника.

  2. 2

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

  3. 3

    Генерирайте чернова чрез работник с ограничена опашка.

  4. 4

    Пълни предметни и езикови прегледи на една идентифицирана редакция.

  5. 5

    Публикувайте, индексирайте и пазете одитната пътека от източника до пускането.

Доставяйте с непокътната възможност за кеширане и достъпност на Drupal

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

Изобразете езиковата навигация като обикновени връзки чрез Drupal маршрутизиране и генериране на URL адреси, съобразени с езика. Добавете реципрочни връзки към източници, метаданни на алтернативен език, навигационни пътеки и записи в карта на сайта. Проверете йерархията на заглавията, целта на връзката, реда на фокусиране, съобщенията за състояние и асоциирането на грешка във формуляра в крайната тема. Дезинфекцирайте изхода на API чрез разрешените структурирани полета и системата за изобразяване на Drupal. Никога не маркирайте генерирания HTML като безопасен само защото идва от доверен сървър.

  • Кеш таговете обхващат източника, езиковата версия, компонентите, медиите, речника и програмата за изобразяване.

  • Обработката на опашка не може да публикува съдържание или да изчисти последния одобрен резултат преждевременно.

  • Езиковите маршрути и връзките към източника работят без JavaScript.

  • Текстовите формати и масивите за изобразяване предотвратяват опасно маркиране.

  • Търсенето индексира само одобрената версия и премахва оттеглените маршрути.

Докажете разрешения, ревизии и връщане назад

Ядрото и функционалните тестове трябва да обхващат валидиране на полето, контрол на достъпа, модериране на преходи, създаване на ревизия, откриване на остарял източник, повторни опити на опашка, анулиране на кеша, достъп до маршрут и изобразяване на всеки поддържан компонент. Тествайте Drupal cron и външни изпълнители на опашки, включително припокриващи се работници и повтарящи се задания. Тестовете на браузъра трябва да упражняват пълния редакционен работен процес с всяка роля и използване само на клавиатурата.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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