Cała dokumentacja

Issue Tracker — Dokumentacja

Issues & FAQ Revolution pozwala publikować znane problemy, komunikaty w stylu FAQ, informacje o kompatybilności, poprawki i obejścia dla produktów w sklepie PrestaShop. Klienci mogą sprawdzić publiczny hub Known Issues albo zakładkę na stronie produktu, zanim otworzą zgłoszenie do supportu.

Funkcje

  • Publiczny hub Known Issues. Moduł dodaje w front office tracker pod adresem /known-issues dla wpisów oczekujących, otwartych, rozwiązanych, zamkniętych oraz takich, które nie będą naprawiane.
  • Zakładka problemów na stronie produktu. Hook displayProductExtraContent dodaje do stron produktów zakładkę Known Issues z liczbą otwartych i wszystkich zgłoszeń.
  • Menedżer problemów w back office. Kontroler AdminMPRIssuesRevolutionIssues udostępnia przeszukiwalną listę z kolumnami produktu, tytułu, statusu, ważności, źródła, głosów, ETA, aktywności i indeksowania.
  • Szczegółowe rekordy problemów. Każdy wpis może przechowywać produkt, wielojęzyczny tytuł i slug, opis, wersje objęte problemem, kroki odtworzenia, obejście, notatkę o rozwiązaniu, status, ważność, zgłoszenia oraz ETA poprawki.
  • Formularz zgłoszenia dla klientów. Publiczny endpoint zgłoszeń zapisuje przesłane raporty jako wpisy oczekujące, z ochroną CSRF, polem honeypot i limitem 3 zgłoszeń na godzinę dla jednego nadawcy.
  • Czytelne publiczne URL-e problemów. Pojedyncze strony problemów używają czytelnych slugów, takich jak /known-issues/checkout-validation-error, a starsze URL-e oparte na ID przekierowują do czystej wersji.
  • Narzędzia przeglądania trackera. Publiczny hub zawiera podsumowania statusów, sekcje ostatnich wpisów oczekujących/otwartych/rozwiązanych, wyszukiwanie, filtrowanie po statusie, sortowanie i kontrolę liczby elementów na stronę.
  • Kontrola SEO. Hub korzysta z polityki SEO modułu dla robots, hreflang, kanonicznych URL-i i kwalifikacji do mapy strony; strony szczegółów problemów i raportowania są wyłączone z indeksowania, hreflang, mapy strony i danych schema.
  • Integracja z mapą strony. Hook gSitemapAppendUrls może dodać hub do map XML, gdy włączenie w sitemapie jest aktywne.
  • Style frontu zgodne z motywem. Moduł rejestruje frontowy CSS przez ThemeDetector i udostępnia stabilne klasy, takie jak .mprissues-page, .mprissues-wrapper, .mpr-f-item oraz .mpr-f-badge.
Issue Tracker — Product known issues tab Issue Tracker — Mprissuesrevolution issue detail status and notes

Opcje konfiguracji

Ustaw je w Improve -> Issues -> Settings -> Configuration.

  • Włącz wyświetlanie na froncie. Włącza lub wyłącza zakładkę produktu i publiczne strony Known Issues; domyślnie: 1.
  • Domyślny status nowych problemów. Określa, czy nowe wpisy w back office zaczynają jako open czy resolved; domyślnie: open.
  • Pozwól użytkownikom zgłaszać problemy. Pokazuje publiczny formularz zgłoszenia i zapisuje poprawne zgłoszenia jako oczekujące raporty; domyślnie: 1.
  • Dodaj hub Known Issues do mapy strony. Pozwala dodać hub przez hook mapy strony; domyślnie: 1.
  • Pozwól indeksować hub Known Issues. Pozwala głównemu hubowi używać zachowania SEO index/follow; domyślnie: 1.
  • Pozwól indeksować pojedyncze strony problemów. Pole konfiguracji dla indeksowania stron problemów; domyślnie: 0. W aktualnej polityce SEO modułu strony szczegółów problemów pozostają nieindeksowalne i są wyłączone z hreflang, mapy strony oraz danych schema.
  • Tytuł zakładki. Ustawia wielojęzyczny tytuł widoczny w zakładkach produktów; domyślnie: Known Issues.
  • Pokaż daty. Wyświetla daty zgłoszenia i aktualizacji w widokach problemów w front office; domyślnie: 1.
  • Pokaż odznaki statusu. Wyświetla etykiety statusu, takie jak Pending, Open, Resolved, Closed i Won't fix; domyślnie: 1.
  • Ukryj zakładkę, gdy jest pusta. Ukrywa zakładkę produktu, gdy produkt nie ma aktywnych publicznych problemów; domyślnie: 1.
Issue Tracker — Known issues hub Issue Tracker — Mprissuesrevolution product tab known issues

Przykłady personalizacji

Przykładowe wartości konfiguracji dla publicznego trackera, w którym klienci mogą czytać wpisy, ale nie mogą wysyłać nowych zgłoszeń:

enabled=1
allow_reporting=0
INCLUDE_IN_SITEMAP=1
ISSUES_HUB_INDEXABLE=1
ISSUE_INDEXABLE=0

Przykładowy wpis problemu dla back office:

Product: Checkout module
Title: Checkout button hidden after theme update
URL slug: checkout-button-hidden-after-theme-update
Status: open
Severity: high
Affected module versions: 2.4.0 - 2.5.2
Affected PrestaShop versions: PrestaShop 8.1 - 8.2
Workaround: Disable the theme's custom checkout override until the next module update.
Active: 1
Index this issue page: 0

Przykład rozwiązanego wpisu:

Status: resolved
Fixed in version: 2.5.20
Resolution note: Fixed compatibility with the updated checkout template.

Obsługiwane wartości statusu i ważności:

status: pending, open, resolved, closed, wontfix
severity: low, medium, high, critical
source: admin, user

Publiczne URL-e, które możesz udostępniać w odpowiedziach supportu:

/known-issues
/known-issues/report
/known-issues/checkout-validation-error

Stany zapytań dla statusu, produktu, wyszukiwania, sortowania i paginacji przekierowują z powrotem do bazowego URL-a hubu.

Tytuł zakładki produktu automatycznie pokazuje liczbę otwartych i wszystkich publicznych problemów:

Known Issues
Known Issues (2/5)

Możesz dostosować style front office w CSS swojego motywu, używając klas modułu:

.mprissues-wrapper .mpr-f-badge--open {
  background: #dc2626;
  color: #fff;
}

.mprissues-detail-panel--workaround {
  border-left-color: #d97706;
}

.mprissues-severity--critical {
  color: #b91c1c;
}

Ścieżki nadpisywania szablonów motywu, gdy Twój motyw potrzebuje własnego markupu:

/themes/your-theme/modules/mprissuesrevolution/views/templates/hook/product-tab.tpl
/themes/your-theme/modules/mprissuesrevolution/views/templates/front/issues.tpl
/themes/your-theme/modules/mprissuesrevolution/views/templates/front/issue.tpl

Publiczny URL hubu jest kontrolowany przez wpis meta PrestaShop instalowany przez moduł:

page: module-mprissuesrevolution-issues
default URL rewrite: known-issues
default title: Known Issues & Bug Tracker
Issue Tracker — Report issue modal Issue Tracker — Mprissuesrevolution product tab report form

Instalacja

  1. W back office przejdź do Modules -> Module Manager.
  2. Kliknij Upload a module i wybierz plik ZIP modułu.
  3. Zainstaluj moduł.
  4. Otwórz Improve -> Issues, aby utworzyć lub przejrzeć wpisy problemów.
  5. Otwórz Settings -> Configuration, aby ustawić wyświetlanie, zgłaszanie, mapę strony i zachowanie indeksowania.
Issue Tracker — Product issues lazy details Issue Tracker — Mprissuesrevolution public tracker status and highlights

Jak to działa

W back office tworzysz wpis problemu lub FAQ, wybierasz produkt, którego dotyczy, ustawiasz status i ważność, a następnie dodajesz publiczne wyjaśnienie, obejście, wersję poprawki albo notatkę o rozwiązaniu.

Klienci widzą te informacje w dwóch miejscach: w zakładce Known Issues na stronie produktu oraz w publicznym hubie Known Issues. Hub pokazuje podsumowania liczników, ostatnie pozycje oczekujące, pozycje otwarte, pozycje rozwiązane, wyszukiwanie, filtrowanie po statusie, sortowanie i linki do pojedynczych stron problemów.

Issue Tracker — Mprissuesrevolution admin issue editor

Uczciwe ograniczenia

  • Moduł publikuje informacje o problemach; nie wykrywa automatycznie błędów w Twoim sklepie.
  • Publiczne zgłoszenia nie obsługują przesyłania plików ani zrzutów ekranu. Klienci, którzy muszą wysłać załączniki, powinni użyć standardowego kanału supportu.
  • Przesłane zgłoszenia są zapisywane jako oczekujące, więc ktoś nadal musi je zweryfikować, zanim zostaną uznane za potwierdzone.
  • Pojedyncze strony problemów pozostają nieindeksowalne zgodnie z polityką SEO modułu, nawet jeśli w back office istnieje flaga indeksowania dla danego problemu.
  • Każdy problem jest powiązany z ID produktu, dlatego moduł najlepiej sprawdza się w katalogach produktów, modułów lub usług.
  • Dla języków innych niż domyślny sklonowana angielska treść problemu może pozostać ukryta, dopóki zlokalizowany tytuł lub opis nie różni się od wersji w języku domyślnym.
Issue Tracker — Mprissuesrevolution admin issue list filters

FAQ

Czy Issues & FAQ Revolution jest widoczny dla klientów?
Tak. Gdy wyświetlanie na froncie jest włączone, klienci mogą zobaczyć publiczny hub Known Issues i zakładkę na stronie produktu.

Czy klienci mogą wysyłać zgłoszenia problemów?
Tak. Publiczne zgłoszenia są zapisywane jako wpisy oczekujące i można je przejrzeć w back office.

Czy mogę powiązać problem z konkretnym produktem lub modułem?
Tak. Każdy problem należy do ID produktu, a strony szczegółów problemu mogą linkować z powrotem do produktu, którego dotyczy, oraz do jego strony dokumentacji.

Czy mogę pokazać znany problem tylko w back office?
Tak. Wyłącz wpis przełącznikiem Active, jeśli nie chcesz, aby był pokazywany publicznie.

Czy pojedyncze strony problemów mogą być indeksowane przez wyszukiwarki?
Nie. Aktualna polityka SEO modułu utrzymuje strony szczegółów problemów jako nieindeksowalne i wyklucza je z hreflang, mapy strony oraz danych schema.

Czy moduł dodaje URL-e do mapy strony?
Tak, gdy włączenie do mapy strony jest aktywne. Hub może zostać dodany; strony szczegółów problemów są pomijane przez aktualną politykę SEO.

Czy mogę zmienić publiczny URL z /known-issues?
Tak. Zmień przepisywanie URL dla strony meta PrestaShop module-mprissuesrevolution-issues w Shop Parameters -> Traffic & SEO.

Czy zgłoszenia obsługują zrzuty ekranu lub załączniki?
Nie. Wbudowany formularz zgłoszenia zapisuje tylko wybrany produkt, tytuł, opis i adres e-mail.

Kompatybilność: PrestaShop 1.6 do 9.0 (najnowsza), PHP 7.1+. Nadal wspieramy nadchodzące wersje PrestaShop.

Issue Tracker — Mprissuesrevolution integrity checks
Do góry