CMS и API

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

Моделирайте версиите на достъпни езици като управлявани записи, свързани с тяхното изходно съдържание и одобрение на работното пространство.

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

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

Моделирайте версиите на достъпни езици като управлявани записи, свързани с тяхното изходно съдържание и одобрение на работното пространство.

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

  1. 1

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

  2. 2

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

  3. 3

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

  4. 4

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

  5. 5

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

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

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

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

Моделирайте езиковите версии като управлявани записи

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

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

Поле за записЦелИзисквано поведение
източник_uidСвързва версия и източникНеизменна връзка с проверка на разрешение
източник_версияОткрива промени в източникаМаркира одобрена версия за преглед, когато е различна
рецензия_състояниеКонтролира работния процесПреходът е ограничен от ролята на бекенда
резултат_идПоддържа проследимостСъхранява се с настройки и време за заявка

Използвайте работни пространства за генериране, преглед и одобрение

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

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

  1. 1

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

  2. 2

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

  3. 3

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

  4. 4

    Разрешете констатациите и потвърдете, че редакцията на източника все още е актуална.

  5. 5

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

Разположете и обезсилете, без да губите одобреното съдържание

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

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

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

  • Търсенето и картата на сайта включват само одобрени записи.

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

  • Защитените източници не могат да изтичат чрез генерирани публични записи.

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

Работете с разширението чрез TYPO3 надстройки

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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