CMS i API

Przewodnik po implementacji Drupal.

Korzystaj z wersji Drupal, moderowania treści i uprawnień do oddzielnego generowania, recenzji specjalistycznych i publikacji.

Wyjaśnij zadanie i decyzję

Ten przewodnik zmienia przewodnik wdrażania drupal 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.

Korzystaj z wersji Drupal, moderowania treści i uprawnień do oddzielnego generowania, recenzji specjalistycznych i publikacji.

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

Moderowany typ zawartości pokazuje pola, role, wersje, dostarczanie i wycofywanie. 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

Utwórz model treści, który zachowuje pochodzenie

Utwórz typ zawartości w przystępnym języku lub jednostkę strukturalną z odwołaniem do encji do wiarygodnego źródła. Uwzględnij identyfikator wersji źródła, ustawienia regionalne, tryb języka, identyfikator wyniku, stan recenzji, wersję glosariusza, poziom ryzyka, osoby zatwierdzające i wyzwalacz następnej recenzji. W przypadku nagłówków, list, łączy, powiadomień, plików do pobrania i informacji kontaktowych używaj akapitów lub pól strukturalnych. Pojedyncze nieograniczone pole tekstu sformatowanego utrudnia weryfikację, ponowne wykorzystanie i bezpieczne renderowanie na poziomie pola.

Wybieraj celowo pomiędzy relacją tłumaczenia Drupal a oddzielną powiązaną jednostką. Tłumaczenie standardowe sprawdza się, gdy struktura pola i cykl życia redakcyjnego pozostają takie same. Oddzielna jednostka jest bezpieczniejsza, gdy dostępna wersja łączy, zmienia kolejność lub wyjaśnia pola źródłowe i wymaga innej moderacji. W obu przypadkach zachowaj niezmienną wersję źródła dla transformacji i wyświetl status nieaktualnego, gdy bieżące źródło już do niego nie pasuje.

Wybór projektuUżyj kiedyWymagane zabezpieczenie
Tłumaczenie treściStruktura i cykl życia pozostają takie sameZmiana miała wpływ na tłumaczenie i testowano moderację
Podmiot powiązanyStruktura, własność lub przegląd są różneWyraźne odniesienie do źródła i wzajemna nawigacja
Mapowanie akapituŹródło zawiera strukturalne bloki wielokrotnego użytkuNieobsługiwane generowanie bloków pakietów lub flag

Odrębna twórczość, recenzja specjalistyczna i publikacja

Skonfiguruj stany moderacji treści, takie jak żądanie, generowanie, wersja robocza, recenzja tematu, kontrola języka, zatwierdzona, opublikowana, nieaktualna i nieudana. Zdefiniuj przejścia dla dedykowanych ról i zweryfikuj je za pomocą uprawnień Drupal i procedur obsługi dostępu. Konto integracji API może tworzyć i aktualizować wersję roboczą, ale nie może zatwierdzać ani publikować. Recenzent tematu nie może zatwierdzić własnego pokolenia wysokiego ryzyka, chyba że pozwala na to udokumentowana polityka ryzyka.

Włącz wersje i upewnij się, że każda transformacja, rozwiązanie komentarza, zmiana statusu i zmiana bazy źródłowej tworzy wersję z autorem i sygnaturą czasową. Utwórz widok recenzji, który pokazuje źródło i wersję roboczą, różnice, ostrzeżenia, łącza i wyrenderowany wynik. Jeśli zmieni się źródło, odpowiednio oznacz aktywną wersję roboczą i opublikowaną wersję i zablokuj publikację do czasu, aż recenzent usunie rozbieżności.

  1. 1

    Skonfiguruj pola encji, sprawdzanie poprawności, wersje i relację źródłową.

  2. 2

    Twórz stany moderacji i przejścia specyficzne dla roli.

  3. 3

    Wygeneruj wersję roboczą za pośrednictwem pracownika kolejki z ograniczeniami.

  4. 4

    Kompletne recenzje przedmiotowe i językowe w ramach jednej zidentyfikowanej wersji.

  5. 5

    Publikuj, indeksuj i przechowuj ścieżkę audytu od źródła do wydania.

Dostarczaj z nienaruszoną pamięcią podręczną i dostępnością Drupal

Dołącz znaczniki pamięci podręcznej dla encji źródłowej, relacji wersji źródła, encji języka, akapitów i multimediów, do których istnieją odniesienia, konfiguracji glosariusza i modułu renderującego. Używaj kontekstów pamięci podręcznej dla ustawień regionalnych i wszelkich prawidłowych odmian dostępu, ale nie uzależniaj zatwierdzonych stron publicznych od stanu generacji specyficznego dla użytkownika. Unieważnij strony, których to dotyczy, poprzez zmiany jednostek lub uzupełnienie kolejki i zachowaj widoczność ostatniej zatwierdzonej wersji podczas sprawdzania zamiennika.

Renderuj nawigację językową jako zwykłe łącza poprzez routing Drupal i generowanie adresów URL uwzględniających język. Dodaj wzajemne linki źródłowe, metadane w alternatywnych językach, bułkę tartą i wpisy mapy witryny. Sprawdź hierarchię nagłówków, cel łącza, kolejność fokusów, komunikaty o stanie i powiązanie błędów formularza w ostatecznym motywie. Oczyść dane wyjściowe API za pomocą dozwolonych pól strukturalnych i systemu renderowania Drupal. Nigdy nie oznaczaj wygenerowanego kodu HTML jako bezpiecznego tylko dlatego, że pochodzi z zaufanego serwera.

  • Tagi pamięci podręcznej obejmują źródło, wersję językową, komponenty, multimedia, glosariusz i moduł renderujący.

  • Przetwarzanie kolejki nie może opublikować treści ani przedwcześnie usunąć ostatniego zatwierdzonego wyniku.

  • Trasy językowe i linki źródłowe działają bez JavaScript.

  • Formaty tekstowe i tablice renderujące zapobiegają niebezpiecznym znacznikom.

  • Wyszukiwanie indeksuje tylko zatwierdzoną wersję i usuwa wycofane trasy.

Sprawdzaj uprawnienia, poprawki i wycofywanie zmian

Testy jądra i funkcjonalności powinny obejmować sprawdzanie poprawności pól, kontrolę dostępu, przejścia moderacji, tworzenie wersji, wykrywanie nieaktualnych źródeł, ponowne próby kolejki, unieważnianie pamięci podręcznej, dostęp do tras i renderowanie każdego obsługiwanego komponentu. Przetestuj cron Drupal i zewnętrzne moduły uruchamiające kolejki, w tym nakładające się procesy robocze i powtarzające się zadania. Testy przeglądarki powinny obejmować pełny przepływ pracy redakcyjnej z każdą rolą i użyciem interfejsu tylko za pomocą klawiatury.

Wersja z zarządzaniem konfiguracją, hakami aktualizacji, rotacją poświadczeń, pulpitami nawigacyjnymi kolejek, odtwarzaniem nieudanych zadań, minimalizacją logów, kopią zapasową bazy danych i elementem runbook przywracania zmian. Zaimportuj konfigurację do środowiska produkcyjnego i potwierdź, że istniejące pakiety, tłumaczenia, uprawnienia i widoki pozostają nienaruszone. Akceptacja obejmuje przywrócenie poprzedniej zatwierdzonej wersji, odbudowanie pamięci podręcznej i indeksów oraz potwierdzenie, że publiczne adresy URL i zapisy audytu pozostają prawidłowe.

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