CMS i API

Przewodnik po implementacji TYPO3.

Modeluj wersje w przystępnych językach jako regulowane rekordy powiązane z ich treścią źródłową i zatwierdzeniem obszaru roboczego.

Wyjaśnij zadanie i decyzję

Ten przewodnik zmienia przewodnik wdrażania typo3 w możliwy do przeglądu przepływ pracy. Łączy decyzje dotyczące domeny, własność, dowody i akceptację, dzięki czemu wynik nadal sprawdza się w produkcji.

Modeluj wersje w przystępnych językach jako regulowane rekordy powiązane z ich treścią źródłową i zatwierdzeniem obszaru roboczego.

Praktyczny proces

  1. 1

    Typy źródeł zasobów reklamowych, identyfikatory, pola, ustawienia regionalne, właściciele i stany publikacji.

  2. 2

    Wybierz wzorzec dostarczania spośród objętości, opóźnienia, kontroli redakcyjnej i tolerancji na awarie.

  3. 3

    Zamapuj rekord źródłowy na osobny rekord wersji językowej z trwałym powiązaniem.

  4. 4

    Dodaj uwierzytelnianie, idempotencję, ponawianie prób, unieważnianie pamięci podręcznej, rejestrowanie i kontrolę dostępu.

  5. 5

    Publikacja testowa, zmiany w źródle, niedostępne wyniki, wycofywanie zmian, obsługa klawiatury i monitorowanie przed wydaniem.

Przykład lub narzędzie

Przykład obszaru roboczego TYPO3 obejmuje mapowanie pól, relacje translacyjne, wdrażanie i unieważnianie. W narzędziu zapisz także punkt odniesienia, właściciela, decyzję, dowody, otwartą kwestię i datę zatwierdzenia. Użyj prawdziwej strony lub transakcji, aby zespół mógł zobaczyć zależności, wyjątki i prace konserwacyjne następujące po wydaniu.

Punkt decyzjiNagrywaćKryterium akceptacji
Linia bazowaZaobserwowany stan obecnyŹródło i data zapisu
DecyzjaWybrana opcja i uzasadnienieUwzględniono ryzyko i odbiorców
DowódTestuj, dokumentuj lub mierzMożliwość przeglądu i specyficzna dla wersji
AprobataImię i nazwisko, rola i dataWszystkie obowiązkowe kryteria spełnione

Modeluj wersje językowe jako rekordy regulowane

Użyj dedykowanego rekordu treści lub typu strony dla wersji w dostępnym języku i połącz ją ze źródłem niezmienną relacją. Przechowuj identyfikator UID źródła, wersję źródłowego obszaru roboczego lub skrót treści, docelowe ustawienia regionalne, tryb języka, identyfikator wyniku transformacji, stan recenzji, wersję glosariusza, osoby zatwierdzające i datę ostatniej weryfikacji. Zachowaj tę relację oddzielnie od zwykłej relacji tłumaczenia ustawień regionalnych TYPO3, gdy wersja zmienia strukturę lub gęstość informacji, a nie tylko język.

Celowo mapuj uporządkowane pola źródłowe. Zachowaj nagłówki, akapity, listy, łącza, tabele, uwagi, pliki do pobrania i bloki kontaktowe jako elementy semantyczne. Zdefiniuj bezpieczną opcję zastępczą dla każdego nieobsługiwanego elementu treści: zachowaj ją z ostrzeżeniem recenzenta, zastąp zatwierdzonym komponentem podsumowania lub wygeneruj blok. Nigdy nie upuszczaj nieznanego elementu po cichu. Odniesienia do plików i łącza zachowują swoje identyfikatory, aby weryfikacja mogła wykryć zmienione lub usunięte zależności.

Pole rekorduZamiarWymagane zachowanie
identyfikator_źródłaŁączy wersję i źródłoNiezmienna relacja ze sprawdzaniem uprawnień
wersja_źródłowaWykrywa zmiany źródłaOznacza zatwierdzoną wersję do sprawdzenia, jeśli jest inna
stan_recenzjiKontroluje przepływ pracyPrzejście ograniczone przez rolę zaplecza
identyfikator_wynikuObsługuje identyfikowalnośćPrzechowywane z ustawieniami i czasem żądania

Użyj obszarów roboczych do generowania, przeglądania i zatwierdzania

Utwórz wygenerowany wynik w kontrolowanym obszarze roboczym, nigdy bezpośrednio w aktywnym obszarze roboczym. Rola generująca może żądać wersji roboczych i je aktualizować. Recenzent tematu potwierdza warunki, liczby, daty, obowiązki i linki. Recenzent językowy sprawdza wybrany tryb i renderowaną podróż. Wydawca weryfikuje rozstrzygnięte ustalenia i przenosi zatwierdzoną wersję przez ustalony etap obszaru roboczego. Wymuś te możliwości w uprawnieniach zaplecza i logice przejścia po stronie serwera.

Skonfiguruj powiadomienia o etapie z adresem URL rekordu, wersją źródła, poziomem ryzyka, wymaganą rolą i terminem. Recenzenci potrzebują znaczącej różnicy, która odróżni zmiany treści od szumu metadanych TYPO3. Jeśli źródło jest edytowane, gdy recenzja jest otwarta, oznacz wersję jako nieaktualną i poproś zespół o dokonanie wyboru między zmianą wersji roboczej a uzupełnieniem wyraźnie zapisanego wyjątku. System musi zapobiegać aktywowaniu nieaktualnego zatwierdzenia.

  1. 1

    Utwórz lub zidentyfikuj rekord źródłowy i przechwyć jego wersję obszaru roboczego.

  2. 2

    Wygeneruj wersję strukturalną w przypisanym obszarze roboczym.

  3. 3

    Pełna weryfikacja tematu, języka i łącza na renderowanym podglądzie.

  4. 4

    Usuń ustalenia i potwierdź, że wersja źródłowa jest nadal aktualna.

  5. 5

    Opublikuj zatwierdzony rekord i zachowaj pełną historię obszaru roboczego.

Wdrażaj i unieważniaj bez utraty zatwierdzonych treści

Twórz rozszerzenia tras i metadane stron, które zapewnią każdej wersji stabilny, czytelny adres URL. Publikuj wzajemne łącza językowe i relacje kanoniczne w znacznikach renderowanych przez serwer. Uwzględnij wersję w wyszukiwarce witryn i mapach witryn XML dopiero po zatwierdzeniu. Skonfiguruj jawnie ograniczenia dostępu i sprawdź, czy strona w języku publicznym nie dziedziczy niezamierzonych ograniczeń strony źródłowej i nie ujawnia chronionej zawartości źródłowej.

Unieważnij prawidłowe pamięci podręczne frontendu, gdy zmieni się zatwierdzona wersja, źródło, plik odniesienia, udostępniony element treści, szablon renderowania lub glosariusz. Użyj tagów pamięci podręcznej, które zawierają zarówno identyfikatory źródła, jak i wersji. Podczas generowania lub przeglądania nadal udostępniaj ostatni zatwierdzony zapis. Nieudane żądanie powoduje utworzenie widocznego zadania zaplecza i zdarzenia operacyjnego, ale nie powoduje usunięcia prawidłowej strony publicznej ani zastąpienia jej wersją roboczą.

  • Każda wersja publiczna ma stabilną trasę i wzajemne łącze źródłowe.

  • Wyszukiwanie i mapa witryny obejmują tylko zatwierdzone rekordy.

  • Tagi pamięci podręcznej obejmują źródło, wersję, współdzielone elementy, pliki i moduł renderujący.

  • Chronione źródła nie mogą przeciekać przez wygenerowane rejestry publiczne.

  • Ostatni zatwierdzony zapis pozostaje dostępny podczas awarii i przeglądu.

Obsługuj rozszerzenie poprzez aktualizacje TYPO3

Przetestuj rozszerzenie pod kątem obsługiwanych wersji TYPO3 z długoterminowym wsparciem, wersji PHP, bazy danych, konfiguracji wielojęzycznej, obszarów roboczych, harmonogramu, rozszerzenia wyszukiwania i warstwy buforowania. Zautomatyzowane testy integracyjne powinny obejmować sprawdzanie uprawnień zaplecza, przechwytywanie modułu DataHandler, trwałość relacji, przejścia obszarów roboczych, unieważnianie pamięci podręcznej, awarię API i wykrywanie nieaktualnych źródeł. Testy przeglądarki obejmują obsługę klawiatury zaplecza i nawigację frontonu przy reprezentatywnych szerokościach.

Przed wydaniem zadania harmonogramu dokumentów, monitorowanie kolejek, rotacja poświadczeń, przechowywanie dzienników, tworzenie kopii zapasowych i przywracanie, migracja schematu i wyłączanie bezpiecznych rozszerzeń. Najpierw wykonaj aktualizacje na kopii tymczasowej przypominającej produkcyjną i zweryfikuj stare zatwierdzone zapisy przed utworzeniem nowych. Akceptacja obejmuje pomyślne wycofanie zarówno kodu rozszerzenia, jak i migracji bazy danych, przy czym opublikowana treść jest nadal dostępna, a historia audytów nienaruszona.

Role, dowody i zatwierdzenie

Trzymaj generowanie oddzielnie od publikacji. Pomyślna odpowiedź to projekt, a nie zatwierdzenie. Przechowuj identyfikator źródła i wersję, ustawienia transformacji, identyfikator wyniku, stan recenzji, osobę zatwierdzającą i godzinę publikacji. Gdy zmieni się źródło, zaznacz wersję językową do sprawdzenia, zamiast po cichu zastępować zatwierdzoną treść. Dzięki temu możliwe jest wycofywanie zmian i inspekcja na różnych platformach.

Eksploatacja i konserwacja

Praca nie kończy się w momencie publikacji. Połącz wersję językową lub konfigurację ze źródłem, monitoruj jakość i miary usług oraz zdefiniuj konkretne wyzwalacze przeglądu. Wyzwalacze obejmują zmiany źródła, zmiany prawne, nowe potrzeby odbiorców, powtarzające się pytania dotyczące pomocy, zmiany techniczne i incydenty. Nazwany właściciel ocenia wyzwalacz, w razie potrzeby otwiera nową wersję i rejestruje ponowne zatwierdzenie.

Lista kontrolna przed publikacją

  • Integracja wykorzystuje trwałe identyfikatory źródła.

  • Poświadczenia są przechowywane po stronie serwera i podlegają rotacji.

  • Zdefiniowano limit czasu, ponowną próbę i zachowanie limitu szybkości.

  • Powtarzające się żądania są idempotentne.

  • Wygenerowana treść przechodzi w stan recenzji.

  • Zmiany źródła unieważniają lub ponownie otwierają wersję.

  • Nawigacja językowa działa za pomocą klawiatury i technologii wspomagających.

  • Monitorowanie obejmuje awarie, kolejki, opóźnienia i nieaktualne treści.

Źródła referencyjne

  1. Dokumentacja Simple8 API
  2. Wzory dostaw Simple8
  3. Wytyczne dotyczące dostępności treści internetowych (WCAG) 2.2

Wprowadź przewodnik w życie

Przetestuj Simple8 z reprezentatywną zawartością i skorzystaj z listy kontrolnej, aby zaplanować kontrolowany przepływ pracy.

Przetestuj własny tekst