Toute la documentation

Issue Tracker — Documentation

Issues & FAQ Revolution vous permet de publier les problèmes connus, avis au format FAQ, notes de compatibilité, correctifs et solutions de contournement pour les produits de votre boutique PrestaShop. Les clients peuvent consulter un hub public Known Issues ou un onglet sur la page produit avant d’ouvrir un ticket de support.

Fonctionnalités

  • Hub public Known Issues. Le module ajoute un suivi en front-office à l’adresse /known-issues pour les entrées en attente, ouvertes, résolues, fermées et ne sera pas corrigé.
  • Onglet des problèmes sur la page produit. Le hook displayProductExtraContent ajoute un onglet Known Issues aux pages produit, avec le nombre de problèmes ouverts et le total.
  • Gestionnaire de problèmes dans le back-office. Le contrôleur AdminMPRIssuesRevolutionIssues fournit une liste consultable avec les colonnes produit, titre, statut, sévérité, source, votes, ETA, actif et indexable.
  • Fiches de problème détaillées. Chaque entrée peut stocker un produit, un titre et un slug multilingues, une description, les versions affectées, les étapes de reproduction, une solution de contournement, une note de résolution, un statut, une sévérité, des signalements et une ETA de correction.
  • Formulaire de signalement client. Le point d’accès public de signalement enregistre les soumissions comme entrées en attente, avec protection CSRF, champ honeypot et limite de 3 envois par heure et par expéditeur.
  • URLs publiques propres pour les problèmes. Les pages de problème individuelles utilisent des slugs lisibles comme /known-issues/checkout-validation-error, tandis que les anciennes URLs basées sur un ID redirigent vers la version propre.
  • Outils de navigation dans le tracker. Le hub public inclut des résumés par statut, des sections récentes pour les éléments en attente/ouverts/résolus, la recherche, le filtrage par statut, le tri et les contrôles du nombre d’éléments par page.
  • Contrôles SEO. Le hub utilise la politique SEO du module pour robots, hreflang, les URLs canoniques et l’éligibilité au sitemap ; les pages de détail et de signalement des problèmes restent exclues de l’indexation, de hreflang, du sitemap et de la sortie schema.
  • Intégration au sitemap. Le hook gSitemapAppendUrls peut ajouter le hub aux sitemaps XML lorsque l’inclusion dans le sitemap est activée.
  • Styles front compatibles avec le thème. Le module enregistre le CSS front via ThemeDetector et expose des classes stables telles que .mprissues-page, .mprissues-wrapper, .mpr-f-item et .mpr-f-badge.
Issue Tracker — Product known issues tab Issue Tracker — Mprissuesrevolution issue detail status and notes

Options de configuration

Définissez ces options dans Improve -> Issues -> Settings -> Configuration.

  • Activer l’affichage front. Active ou désactive l’onglet produit et les pages publiques Known Issues ; valeur par défaut : 1.
  • Statut par défaut des nouveaux problèmes. Définit si les nouvelles entrées du back-office commencent en open ou resolved ; valeur par défaut : open.
  • Autoriser les utilisateurs à signaler des problèmes. Affiche le formulaire public de signalement et enregistre les soumissions valides comme signalements en attente ; valeur par défaut : 1.
  • Inclure le hub Known Issues dans le sitemap. Permet d’ajouter le hub via le hook de sitemap ; valeur par défaut : 1.
  • Autoriser l’indexation du hub Known Issues. Permet au hub principal d’utiliser un comportement SEO index/follow ; valeur par défaut : 1.
  • Autoriser l’indexation des pages de problème individuelles. Champ de configuration pour l’indexation des pages de problème ; valeur par défaut : 0. Dans la politique SEO actuelle du module, les pages de détail des problèmes restent non indexables et sont exclues de hreflang, du sitemap et de la sortie schema.
  • Titre de l’onglet. Définit le titre multilingue affiché dans les onglets produit ; valeur par défaut : Known Issues.
  • Afficher les dates. Affiche les dates de signalement et de mise à jour dans les vues front-office des problèmes ; valeur par défaut : 1.
  • Afficher les badges de statut. Affiche les libellés de statut comme Pending, Open, Resolved, Closed et Won't fix ; valeur par défaut : 1.
  • Masquer l’onglet lorsqu’il est vide. Masque l’onglet produit lorsque le produit n’a aucun problème public actif ; valeur par défaut : 1.
Issue Tracker — Known issues hub Issue Tracker — Mprissuesrevolution product tab known issues

Exemples de personnalisation

Exemples de valeurs de configuration pour un tracker public où les clients peuvent lire les entrées mais ne peuvent pas soumettre de nouveaux signalements :

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

Exemple d’entrée de problème pour le 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

Exemple d’entrée résolue :

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

Valeurs de statut et de sévérité prises en charge :

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

URLs publiques que vous pouvez partager dans vos réponses de support :

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

Les états de requête liés au statut, au produit, à la recherche, au tri et à la pagination redirigent vers l’URL de base du hub.

Le titre de l’onglet produit affiche automatiquement le nombre de problèmes publics ouverts et le total :

Known Issues
Known Issues (2/5)

Vous pouvez ajuster les styles du front-office depuis le CSS de votre thème avec les classes du module :

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

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

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

Chemins de surcharge des templates de thème lorsque votre thème a besoin d’un balisage personnalisé :

/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

L’URL publique du hub est contrôlée par l’entrée meta PrestaShop installée par le module :

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

Installation

  1. Dans votre back-office, allez dans Modules -> Module Manager.
  2. Cliquez sur Upload a module et sélectionnez le fichier ZIP du module.
  3. Installez le module.
  4. Ouvrez Improve -> Issues pour créer ou vérifier les entrées de problème.
  5. Ouvrez Settings -> Configuration pour définir l’affichage, les signalements, le sitemap et le comportement d’indexation.
Issue Tracker — Product issues lazy details Issue Tracker — Mprissuesrevolution public tracker status and highlights

Fonctionnement

Dans le back-office, vous créez une entrée de problème ou de FAQ, vous choisissez le produit affecté, vous définissez son statut et sa sévérité, puis vous ajoutez l’explication publique, la solution de contournement, la version de correction ou la note de résolution.

Les clients voient l’information à deux endroits : un onglet Known Issues sur la page produit et le hub public Known Issues. Le hub affiche les compteurs récapitulatifs, les éléments récents en attente, les éléments ouverts, les éléments résolus, la recherche, le filtrage par statut, le tri et les liens vers les pages de problème individuelles.

Issue Tracker — Mprissuesrevolution admin issue editor

Limites honnêtes

  • Le module publie des informations sur les problèmes ; il ne détecte pas automatiquement les bugs dans votre boutique.
  • Les signalements publics ne prennent pas en charge l’envoi de fichiers ou de captures d’écran. Les clients qui doivent transmettre des pièces jointes doivent utiliser votre canal de support habituel.
  • Les signalements soumis sont enregistrés comme en attente : une personne doit donc encore les vérifier avant de les considérer comme confirmés.
  • Les pages de problème individuelles restent non indexables selon la politique SEO du module, même lorsqu’un indicateur d’indexation par problème existe dans le back-office.
  • Chaque problème est lié à un ID produit, ce qui convient surtout aux catalogues de produits, de modules ou de services.
  • Pour les langues non définies par défaut, le contenu anglais cloné d’un problème peut rester masqué jusqu’à ce que le titre ou la description localisés diffèrent de la version de la langue par défaut.
Issue Tracker — Mprissuesrevolution admin issue list filters

FAQ

Issues & FAQ Revolution est-il visible par les clients ?
Oui. Lorsque l’affichage front est activé, les clients peuvent voir le hub public Known Issues et l’onglet sur la page produit.

Les clients peuvent-ils envoyer des signalements de problème ?
Oui. Les signalements publics sont enregistrés comme entrées en attente et peuvent être vérifiés dans le back-office.

Puis-je lier un problème à un produit ou module précis ?
Oui. Chaque problème appartient à un ID produit, et les pages de détail peuvent renvoyer vers le produit affecté et sa page de documentation.

Puis-je afficher un problème connu uniquement dans le back-office ?
Oui. Désactivez l’entrée avec son interrupteur Active si vous ne voulez pas qu’elle soit affichée publiquement.

Les pages de problème individuelles peuvent-elles être indexées par les moteurs de recherche ?
Non. La politique SEO actuelle du module garde les pages de détail des problèmes non indexables et les exclut de hreflang, du sitemap et de la sortie schema.

Le module ajoute-t-il des URLs au sitemap ?
Oui, lorsque l’inclusion dans le sitemap est activée. Le hub peut être inclus ; les pages de détail des problèmes sont ignorées par la politique SEO actuelle.

Puis-je modifier l’URL publique /known-issues ?
Oui. Modifiez la réécriture d’URL de la page meta PrestaShop module-mprissuesrevolution-issues dans Shop Parameters -> Traffic & SEO.

Les captures d’écran ou pièces jointes sont-elles prises en charge dans les signalements ?
Non. Le formulaire de signalement intégré stocke uniquement le produit sélectionné, le titre, la description et l’adresse e-mail.

Compatibilité : PrestaShop 1.6 à 9.0 (dernière version), PHP 7.1+. Nous continuons à prendre en charge les prochaines versions de PrestaShop.

Issue Tracker — Mprissuesrevolution integrity checks
Retour en haut