Issue Tracker — Documentación

Issues & FAQ Revolution le permite publicar problemas conocidos, avisos tipo FAQ, notas de compatibilidad, correcciones y soluciones alternativas para productos de su tienda PrestaShop. Los clientes pueden consultar un hub público Known Issues o una pestaña en la página de producto antes de abrir un ticket de soporte.

Funciones

• Hub público Known Issues. El módulo añade un tracker en el front office en /known-issues para entradas pendientes, abiertas, resueltas, cerradas y que no se corregirán.
• Pestaña de problemas en la página de producto. El hook displayProductExtraContent añade una pestaña Known Issues a las páginas de producto con el recuento de problemas abiertos y totales.
• Gestor de problemas en el back office. El controlador AdminMPRIssuesRevolutionIssues ofrece una lista con búsqueda y columnas de producto, título, estado, gravedad, origen, votos, ETA, activo e indexable.
• Registros de problema detallados. Cada entrada puede guardar un producto, título y slug multilingües, descripción, versiones afectadas, pasos de reproducción, solución alternativa, nota de resolución, estado, gravedad, informes y ETA de corrección.
• Formulario de informe para clientes. El endpoint público de informes guarda los envíos como entradas pendientes, con protección CSRF, campo honeypot y límite de 3 envíos por hora por remitente.
• URLs públicas limpias para problemas. Las páginas individuales de problema usan slugs legibles como /known-issues/checkout-validation-error, mientras que las URLs antiguas basadas en ID redirigen a la versión limpia.
• Herramientas para navegar por el tracker. El hub público incluye resúmenes de estado, secciones recientes de elementos pendientes/abiertos/resueltos, búsqueda, filtrado por estado, ordenación y controles de elementos por página.
• Controles SEO. El hub usa la política SEO del módulo para robots, hreflang, URLs canónicas y elegibilidad para el sitemap; las páginas de detalle e informe de problemas quedan fuera de la indexación, hreflang, sitemap y salida schema.
• Integración con sitemap. El hook gSitemapAppendUrls puede añadir el hub a sitemaps XML cuando la inclusión en sitemap está activada.
• Estilos front adaptados al tema. El módulo registra CSS front mediante ThemeDetector y expone clases estables como .mprissues-page, .mprissues-wrapper, .mpr-f-item y .mpr-f-badge.

Opciones de configuración

Configure estas opciones en Improve -> Issues -> Settings -> Configuration.

• Activar visualización front. Activa o desactiva la pestaña de producto y las páginas públicas Known Issues; valor predeterminado: 1.
• Estado predeterminado para nuevos problemas. Define si las nuevas entradas del back office empiezan como open o resolved; valor predeterminado: open.
• Permitir que los usuarios informen problemas. Muestra el formulario público de informe y guarda los envíos válidos como informes pendientes; valor predeterminado: 1.
• Incluir el hub Known Issues en el sitemap. Permite añadir el hub mediante el hook del sitemap; valor predeterminado: 1.
• Permitir indexación del hub Known Issues. Permite que el hub principal use comportamiento SEO index/follow; valor predeterminado: 1.
• Permitir indexación de páginas individuales de problema. Campo de configuración para la indexación de páginas de problema; valor predeterminado: 0. En la política SEO actual del módulo, las páginas de detalle de problema siguen sin ser indexables y se excluyen de hreflang, sitemap y salida schema.
• Título de la pestaña. Define el título multilingüe que se muestra en las pestañas de producto; valor predeterminado: Known Issues.
• Mostrar fechas. Muestra fechas de informe y actualización en las vistas de problema del front office; valor predeterminado: 1.
• Mostrar badges de estado. Muestra etiquetas de estado como Pending, Open, Resolved, Closed y Won't fix; valor predeterminado: 1.
• Ocultar pestaña cuando esté vacía. Oculta la pestaña de producto cuando el producto no tiene problemas públicos activos; valor predeterminado: 1.

Ejemplos de personalización

Valores de configuración de ejemplo para un tracker público donde los clientes pueden leer entradas, pero no enviar nuevos informes:

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

Ejemplo de entrada de problema para el 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

Ejemplo de entrada resuelta:

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

Valores de estado y gravedad compatibles:

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

URLs públicas que puede compartir en respuestas de soporte:

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

Los estados de petición de estado, producto, búsqueda, ordenación y paginación redirigen de vuelta a la URL base del hub.

El título de la pestaña de producto muestra automáticamente el número de problemas públicos abiertos y totales:

Known Issues
Known Issues (2/5)

Puede ajustar los estilos del front office desde el CSS de su tema con las clases del módulo:

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

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

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

Rutas de override de plantillas del tema cuando su tema necesita marcado personalizado:

/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

La URL pública del hub se controla mediante la entrada meta de PrestaShop instalada por el módulo:

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

Instalación

1. En su back office, vaya a Modules -> Module Manager.
2. Haga clic en Upload a module y seleccione el archivo ZIP del módulo.
3. Instale el módulo.
4. Abra Improve -> Issues para crear o revisar entradas de problema.
5. Abra Settings -> Configuration para configurar la visualización, los informes, el sitemap y el comportamiento de indexación.

Cómo funciona

En el back office, usted crea una entrada de problema o FAQ, elige el producto afectado, establece su estado y gravedad, y luego añade la explicación pública, la solución alternativa, la versión de corrección o la nota de resolución.

Los clientes ven la información en dos lugares: una pestaña Known Issues en la página de producto y el hub público Known Issues. El hub muestra recuentos resumidos, elementos pendientes recientes, elementos abiertos, elementos resueltos, búsqueda, filtrado por estado, ordenación y enlaces a páginas individuales de problema.

Límites claros

• El módulo publica información sobre problemas; no detecta automáticamente errores en su tienda.
• Los informes públicos no incluyen subida de archivos ni capturas de pantalla. Los clientes que necesiten enviar adjuntos deben usar su canal de soporte habitual.
• Los informes enviados se guardan como pendientes, por lo que alguien debe revisarlos antes de tratarlos como confirmados.
• Las páginas individuales de problema se mantienen no indexables por la política SEO del módulo, incluso cuando existe en el back office el indicador de indexación por problema.
• Cada problema está vinculado a un ID de producto, por lo que encaja mejor con catálogos de productos, módulos o servicios.
• Para idiomas que no sean el predeterminado, el contenido de problema clonado desde inglés puede permanecer oculto hasta que el título o la descripción localizados difieran de la versión del idioma predeterminado.

FAQ

¿Issues & FAQ Revolution es visible para los clientes?
Sí. Cuando la visualización front está activada, los clientes pueden ver el hub público Known Issues y la pestaña de la página de producto.

¿Los clientes pueden enviar informes de problemas?
Sí. Los informes públicos se guardan como entradas pendientes y pueden revisarse en el back office.

¿Puedo vincular un problema a un producto o módulo concreto?
Sí. Cada problema pertenece a un ID de producto, y las páginas de detalle de problema pueden enlazar de vuelta al producto afectado y a su página de documentación.

¿Puedo mostrar un problema conocido solo en el back office?
Sí. Desactive la entrada con su interruptor Active si no quiere que se muestre públicamente.

¿Las páginas individuales de problema pueden ser indexadas por motores de búsqueda?
No. La política SEO actual del módulo mantiene las páginas de detalle de problema como no indexables y las excluye de hreflang, sitemap y salida schema.

¿El módulo añade URLs al sitemap?
Sí, cuando la inclusión en sitemap está activada. El hub puede incluirse; las páginas de detalle de problema se omiten según la política SEO actual.

¿Puedo cambiar la URL pública desde /known-issues?
Sí. Cambie la reescritura de URL de la página meta de PrestaShop module-mprissuesrevolution-issues en Shop Parameters -> Traffic & SEO.

¿Se admiten capturas de pantalla o archivos adjuntos en los informes?
No. El formulario de informe integrado solo guarda el producto seleccionado, el título, la descripción y la dirección de correo electrónico.

Compatibilidad: PrestaShop 1.6 a 9.0 (última versión), PHP 7.1+. Seguimos dando soporte a las próximas versiones de PrestaShop.