CMS i API

Przewodnik po implementacji WordPress.

Wybierz celowo dostawę widgetu lub API, zachowaj kanoniczną stronę oryginalną i publikuj wersje językowe w drodze poprawek.

Wyjaśnij zadanie i decyzję

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

Wybierz celowo dostawę widgetu lub API, zachowaj kanoniczną stronę oryginalną i publikuj wersje językowe w drodze poprawek.

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

Przepływ pracy Gutenberga mapuje strony źródłowe, stany recenzji, klucze pamięci podręcznej i nawigację językową. 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

Wybierz widget, wtyczkę lub dostawę API po stronie serwera

Użyj widżetu, gdy liczy się szybkość wdrożenia, strony źródłowe mają już trwałe identyfikatory i akceptowalna jest zależność po stronie klienta. Użyj wtyczki WordPress, gdy redaktorzy potrzebują generowania i przeglądania w interfejsie administracyjnym. Użyj dostarczania API po stronie serwera, gdy wersje językowe muszą być indeksowane, buforowane, dołączane do kanałów informacyjnych i renderowane nawet wtedy, gdy JavaScript jest niedostępny. Duzi wydawcy często łączą wtyczkę do przepływu pracy z renderowaniem po stronie serwera w celu dostarczenia.

Udokumentuj wybór pod względem kontroli redakcyjnej, wydajności, dostępności, wyszukiwania, zachowania w przypadku awarii, przepływu danych i własności konserwacji. Oryginalna strona pozostaje wiarygodnym źródłem. Wersja językowa otrzymuje własny post lub uporządkowany zapis, stabilny adres URL, status recenzji i link do wersji źródłowej. Unikaj przechowywania alternatywnej treści wyłącznie w niewersjonowanym niestandardowym polu lub w pamięci podręcznej przeglądarki, ponieważ recenzenci nie mogą jej wiarygodnie zatwierdzić, przywrócić ani sprawdzić.

WzórNajlepsze dopasowanieKontrola podstawowa
WidżetSzybkie dodanie do kontrolowanej witrynyDostępny stan awaryjny i awaryjny
Praca z wtyczkamiRedaktorzy pracują całkowicie w WordPressRole, nonces, możliwości i wersje
API po stronie serweraIndeksowane, buforowane i odporne stronyKolejka, unieważnianie pamięci podręcznej i operacje wdrażania

Modeluj relacje źródłowe i stany redakcyjne

Utwórz typ postu w wersji językowej lub użyj wielojęzycznej struktury obsługującej wyraźne relacje źródłowe. Przechowuj identyfikator wpisu źródłowego, identyfikator wersji źródła, docelowe ustawienia regionalne, tryb językowy, identyfikator wyniku, wersję glosariusza, stan recenzji, osoby zatwierdzające, opublikowaną wersję i wyzwalacz recenzji. Jeśli to możliwe, zachowaj przekształconą strukturę bloków, aby nagłówki, listy, łącza, tabele i uwagi pozostały semantyczne, a nie spłaszczone w jednym polu HTML.

Zdefiniuj statusy dla żądanych, generowanych, wersji roboczej, recenzji tematycznej, recenzji językowej, zatwierdzonych, opublikowanych, nieaktualnych i zakończonych niepowodzeniem. Przypisz każde przejście do możliwości WordPress, a nie tylko do widocznego przycisku. Generator może utworzyć wersję roboczą, ale nie może jej zatwierdzić. Gdy zmieni się źródło, porównaj jego wersję z zatwierdzoną wersją źródłową i przenieś wersję językową do przestarzałej lub wymaganej recenzji. Nie publikuj po cichu wygenerowanego wyniku.

  1. 1

    Zarejestruj rekord wersji językowej i wymagane metadane z uprawnieniami do oczyszczania i REST.

  2. 2

    Mapuj obsługiwane bloki Gutenberga i definiuj zachowanie nieobsługiwanych bloków.

  3. 3

    Skonfiguruj role i dozwolone zmiany statusu.

  4. 4

    Wygeneruj w osobnej wersji i przedstaw porównanie źródłowe.

  5. 5

    Publikuj dopiero po wymaganych zatwierdzeniach dotyczących poziomu ryzyka treści.

Bezpiecznie buforuj i zapewniaj trwałą nawigację językową

Twórz klucze pamięci podręcznej na podstawie witryny, identyfikatora postu źródłowego, wersji źródła, ustawień regionalnych, trybu językowego i wersji modułu renderującego. Unieważnij powiązaną stronę językową, gdy zmieni się jej zatwierdzona wersja, zmieni się źródło, zmieni się wspólny blok lub ponownie opublikuje się odpowiednia reguła terminologiczna. Jeśli przetwarzanie przebiega asynchronicznie, udostępnij ostatnią zatwierdzoną wersję do czasu sprawdzenia nowej wersji roboczej. Nigdy nie zastępuj zatwierdzonej treści pustym stanem, ponieważ generowanie jest niedostępne.

Dodaj linki językowe jako zwykłe kotwice renderowane przez serwer z wyraźnymi nazwami, takimi jak „prosty język” i „ETR”. Dołącz wzajemne linki do strony źródłowej i poprawne metadane w języku alternatywnym. Zachowaj fokus klawiatury po przełączeniu na stronie i ogłaszaj zmianę trasy tylko za pomocą normalnego tytułu i nagłówka strony. Brakująca wersja powinna wyjaśniać, że jest niedostępna i odsyłać do źródła, a nie ukrywać kontrolę lub po cichu wracać do pętli.

  • Klucze pamięci podręcznej obejmują wersje źródłowe i renderujące.

  • Ostatnia zatwierdzona strona przETRwa API i awarie kolejki.

  • Linki językowe działają bez JavaScript i korzystają z zatwierdzonej terminologii.

  • Metadane kanoniczne i alternatywne odzwierciedlają rzeczywistą relację.

  • Zmiany w bloku współdzielonym i glosariuszu uruchamiają zadania przeglądu, których to dotyczy.

Przetestuj pełną ścieżkę publikowania i wycofywania zmian

Użyj kopii tymczasowej z reprezentatywnymi blokami Gutenberga, polami niestandardowymi, osadzonymi formularzami, blokami wielokrotnego użytku i postami z ograniczeniami. Generowanie testów, wymuszanie ról, komentarze do recenzji, zaplanowana publikacja, podgląd, unieważnianie pamięci podręcznej, aktualizacja źródła, nieaktualne oznaczanie, usuwanie, przywracanie i wycofywanie zmian. Upewnij się, że punkty końcowe REST odrzucają nieautoryzowane odczyty i zapisy oraz że zadań w tle nie można wyzwalać między lokacjami bez ważnych danych jednorazowych lub poświadczeń serwera.

Przed rozpoczęciem produkcji zdefiniuj monitorowanie kolejki, własność błędów, rotację poświadczeń, testowanie aktualizacji wtyczek, tworzenie kopii zapasowych bazy danych i procedurę bezpiecznego wyłączania. Akceptacja wymaga prawidłowego renderowania w typowych punktach przerwania, nawigacji za pomocą klawiatury i czytnika ekranu, braku zmiany układu w stosunku do późnej treści, prawidłowych nagłówków strukturalnych, identyfikowalnego zatwierdzenia i przywrócenia ostatniej zatwierdzonej wersji. Zapisz obsługiwane konfiguracje WordPress, PHP, edytora, wielojęzycznej wtyczki i konfiguracji buforowania.

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