Issue Tracker — Dokumentation

Issues & FAQ Revolution ermöglicht Ihnen, bekannte Probleme, FAQ-artige Hinweise, Kompatibilitätsinformationen, Korrekturen und Workarounds für Produkte in Ihrem PrestaShop-Shop zu veröffentlichen. Kunden können den öffentlichen Known Issues Hub oder einen Tab auf der Produktseite prüfen, bevor sie ein Support-Ticket eröffnen.

Funktionen

• Öffentlicher Known Issues Hub. Das Modul ergänzt den Front Office um einen Tracker unter /known-issues für Einträge mit dem Status ausstehend, offen, gelöst, geschlossen und wird nicht behoben.
• Problem-Tab auf Produktseiten. Der Hook displayProductExtraContent fügt Produktseiten einen Known Issues Tab mit der Anzahl offener und gesamter Einträge hinzu.
• Problemverwaltung im Back Office. Der Controller AdminMPRIssuesRevolutionIssues stellt eine durchsuchbare Liste mit Produkt, Titel, Status, Schweregrad, Quelle, Stimmen, ETA, Aktiv- und Indexierbar-Spalten bereit.
• Detaillierte Problemdatensätze. Jeder Eintrag kann ein Produkt, mehrsprachigen Titel und Slug, Beschreibung, betroffene Versionen, Reproduktionsschritte, Workaround, Lösungsnotiz, Status, Schweregrad, Meldungen und voraussichtlichen Fix-Termin speichern.
• Meldeformular für Kunden. Der öffentliche Melde-Endpunkt speichert eingereichte Meldungen als ausstehende Einträge, geschützt durch CSRF-Schutz, ein Honeypot-Feld und ein Limit von 3 Einsendungen pro Stunde und Absender.
• Saubere öffentliche Problem-URLs. Einzelne Problemseiten verwenden lesbare Slugs wie /known-issues/checkout-validation-error, während ältere ID-basierte URLs auf die saubere Version weiterleiten.
• Werkzeuge zum Durchsuchen des Trackers. Der öffentliche Hub enthält Statusübersichten, aktuelle Bereiche für ausstehende/offene/gelöste Einträge, Suche, Statusfilter, Sortierung und Steuerelemente für Einträge pro Seite.
• SEO-Steuerung. Der Hub verwendet die SEO-Richtlinie des Moduls für robots, hreflang, kanonische URLs und Sitemap-Eignung; Problemdetail- und Meldeseiten bleiben von Indexierung, hreflang, Sitemap und Schema-Ausgabe ausgeschlossen.
• Sitemap-Integration. Der Hook gSitemapAppendUrls kann den Hub zu XML-Sitemaps hinzufügen, wenn die Sitemap-Aufnahme aktiviert ist.
• Theme-bewusstes Front-Styling. Das Modul registriert Front-CSS über ThemeDetector und stellt stabile Klassen wie .mprissues-page, .mprissues-wrapper, .mpr-f-item und .mpr-f-badge bereit.

Konfigurationsoptionen

Legen Sie diese unter Improve -> Issues -> Settings -> Configuration fest.

• Front-Anzeige aktivieren. Schaltet den Produkt-Tab und die öffentlichen Known Issues Seiten ein oder aus; Standard: 1.
• Standardstatus für neue Probleme. Legt fest, ob neue Back-Office-Einträge als open oder resolved starten; Standard: open.
• Benutzern das Melden von Problemen erlauben. Zeigt das öffentliche Meldeformular und speichert gültige Einsendungen als ausstehende Meldungen; Standard: 1.
• Known Issues Hub in Sitemap aufnehmen. Erlaubt, den Hub über den Sitemap-Hook hinzuzufügen; Standard: 1.
• Indexierung des Known Issues Hub erlauben. Lässt den Haupt-Hub Index/Follow-SEO-Verhalten nutzen; Standard: 1.
• Indexierung einzelner Problemseiten erlauben. Konfigurationsfeld für die Indexierung von Problemseiten; Standard: 0. In der aktuellen SEO-Richtlinie des Moduls bleiben Problemdetailseiten nicht indexierbar und sind von hreflang, Sitemap und Schema-Ausgabe ausgeschlossen.
• Tab-Titel. Legt den mehrsprachigen Titel fest, der auf Produkt-Tabs angezeigt wird; Standard: Known Issues.
• Daten anzeigen. Zeigt Melde- und Aktualisierungsdaten in Problemansichten im Front Office an; Standard: 1.
• Status-Badges anzeigen. Zeigt Statuslabels wie Pending, Open, Resolved, Closed und Won't fix an; Standard: 1.
• Tab ausblenden, wenn leer. Blendet den Produkt-Tab aus, wenn das Produkt keine aktiven öffentlichen Probleme hat; Standard: 1.

Anpassungsbeispiele

Beispiel-Konfigurationswerte für einen öffentlichen Tracker, in dem Kunden Einträge lesen, aber keine neuen Meldungen einreichen können:

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

Beispiel für einen Problem-Eintrag im 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

Beispiel für einen gelösten Eintrag:

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

Unterstützte Status- und Schweregradwerte:

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

Öffentliche URLs, die Sie in Support-Antworten teilen können:

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

Anfragestatus für Status, Produkt, Suche, Sortierung und Paginierung leiten zurück zur Basis-URL des Hubs.

Der Produkt-Tab-Titel zeigt automatisch die Anzahl offener und gesamter öffentlicher Probleme an:

Known Issues
Known Issues (2/5)

Sie können das Front-Office-Styling über das CSS Ihres Themes mit den Modulklassen anpassen:

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

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

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

Theme-Template-Override-Pfade, falls Ihr Theme eigenes Markup benötigt:

/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

Die öffentliche Hub-URL wird über den vom Modul installierten PrestaShop-Meta-Eintrag gesteuert:

page: module-mprissuesrevolution-issues
default URL rewrite: known-issues
default title: Known Issues & Bug Tracker

Installation

1. Gehen Sie in Ihrem Back Office zu Modules -> Module Manager.
2. Klicken Sie auf Upload a module und wählen Sie die ZIP-Datei des Moduls aus.
3. Installieren Sie das Modul.
4. Öffnen Sie Improve -> Issues, um Problem-Einträge zu erstellen oder zu prüfen.
5. Öffnen Sie Settings -> Configuration, um Anzeige, Meldungen, Sitemap und Indexierungsverhalten einzustellen.

So funktioniert es

Im Back Office erstellen Sie einen Problem- oder FAQ-Eintrag, wählen das betroffene Produkt, setzen Status und Schweregrad und ergänzen anschließend die öffentliche Erklärung, den Workaround, die Fix-Version oder die Lösungsnotiz.

Kunden sehen die Informationen an zwei Stellen: in einem Known Issues Tab auf der Produktseite und im öffentlichen Known Issues Hub. Der Hub zeigt Zusammenfassungszahlen, aktuelle ausstehende Einträge, offene Einträge, gelöste Einträge, Suche, Statusfilter, Sortierung und Links zu einzelnen Problemseiten.

Ehrliche Grenzen

• Das Modul veröffentlicht Probleminformationen; es erkennt Fehler in Ihrem Shop nicht automatisch.
• Öffentliche Meldungen unterstützen keine Datei- oder Screenshot-Uploads. Kunden, die Anhänge senden müssen, sollten Ihren normalen Support-Kanal verwenden.
• Eingereichte Meldungen werden als ausstehend gespeichert, daher muss sie weiterhin jemand prüfen, bevor sie als bestätigt behandelt werden.
• Einzelne Problemseiten bleiben durch die SEO-Richtlinie des Moduls nicht indexierbar, auch wenn im Back Office ein Indexierbar-Flag pro Problem vorhanden ist.
• Jedes Problem ist mit einer Produkt-ID verknüpft, daher eignet sich das Modul am besten für Produkt-, Modul- oder serviceartige Kataloge.
• Bei nicht standardmäßigen Sprachen können geklonte englische Probleminhalte ausgeblendet bleiben, bis sich der lokalisierte Titel oder die Beschreibung von der Version der Standardsprache unterscheidet.

FAQ

Ist Issues & FAQ Revolution für Kunden sichtbar?
Ja. Wenn die Front-Anzeige aktiviert ist, können Kunden den öffentlichen Known Issues Hub und den Produktseiten-Tab sehen.

Können Kunden Problemmeldungen einreichen?
Ja. Öffentliche Meldungen werden als ausstehende Einträge gespeichert und können im Back Office geprüft werden.

Kann ich ein Problem mit einem bestimmten Produkt oder Modul verknüpfen?
Ja. Jedes Problem gehört zu einer Produkt-ID, und Problemdetailseiten können zurück zum betroffenen Produkt und zu dessen Dokumentationsseite verlinken.

Kann ich ein bekanntes Problem nur im Back Office anzeigen?
Ja. Deaktivieren Sie den Eintrag mit seinem Active-Schalter, wenn er nicht öffentlich angezeigt werden soll.

Können einzelne Problemseiten von Suchmaschinen indexiert werden?
Nein. Die aktuelle SEO-Richtlinie des Moduls hält Problemdetailseiten nicht indexierbar und schließt sie von hreflang, Sitemap und Schema-Ausgabe aus.

Fügt das Modul URLs zur Sitemap hinzu?
Ja, wenn die Sitemap-Aufnahme aktiviert ist. Der Hub kann aufgenommen werden; Problemdetailseiten werden durch die aktuelle SEO-Richtlinie übersprungen.

Kann ich die öffentliche URL von /known-issues ändern?
Ja. Ändern Sie den URL-Rewrite für die PrestaShop-Metaseite module-mprissuesrevolution-issues unter Shop Parameters -> Traffic & SEO.

Werden Screenshots oder Dateianhänge in Meldungen unterstützt?
Nein. Das integrierte Meldeformular speichert nur das ausgewählte Produkt, den Titel, die Beschreibung und die E-Mail-Adresse.

Kompatibilität: PrestaShop 1.6 bis 9.0 (neueste Version), PHP 7.1+. Wir unterstützen auch weiterhin kommende PrestaShop-Versionen.