Guide d’installation, de configuration et de déploiement du module Kowal TrustedUs

Objectif du module

Kowal TrustedUs est un module Magento 2 universel pour présenter des entreprises, clients, partenaires, fournisseurs, marques et études de cas dans la boutique.

Le module peut être utilisé comme :

• section 'Ils nous font confiance',
• liste de partenaires ou de fournisseurs,
• portfolio de réalisations,
• base d’études de cas,
• section montrant les usages des produits,
• outil renforçant le maillage interne dans la boutique.

Après la dernière extension, les widgets peuvent mener vers des pages internes d’étude de cas, par exemple :

/trusted-us/vitcas

Sur cette page, les entrées du même groupe ainsi que les produits qui leur sont associés sont affichés.

Exigences

Avant l’installation, assurez-vous que la boutique répond aux exigences :

• elle fonctionne sur Magento 2,
• elle dispose d’un accès à Composer,
• elle dispose d’un accès au dépôt du module,
• elle dispose d’un token GitHub configuré si le dépôt est privé,
• elle permet d’exécuter les commandes bin/magento,
• une sauvegarde du code et de la base de données a été effectuée avant le déploiement en production.

Installation via Composer

1. Ajout du dépôt Composer

Dans le répertoire racine de Magento, exécutez :

composer config repositories.kowal.trusted.us vcs https://github.com/kowalco/trusted-us

2. Ajout du token d’accès

Si le dépôt est privé, ajoutez le token GitHub :

composer config --global --auth github-oauth.github.com 

3. Installation du module

composer require kowal/module-trustedus

4. Activation du module

Nom du module Magento :

Kowal_TrustedUs

Activez le module :

php bin/magento module:enable Kowal_TrustedUs

5. Mise à jour du schéma de la base de données

php bin/magento setup:upgrade

Cette commande créera ou mettra à jour les tables du module, y compris le champ group_slug utilisé pour les pages internes d’étude de cas.

6. Nettoyage du cache

php bin/magento cache:flush

Installation en mode production

Sur l’environnement de production, le processus de déploiement standard de Magento est recommandé.

Exemple de séquence :

composer require kowal/module-trustedusphp bin/magento module:enable Kowal_TrustedUsphp bin/magento setup:upgrade --keep-generatedphp bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -fphp bin/magento cache:flush

Si la boutique dispose de son propre pipeline CI/CD, les étapes ci-dessus doivent être adaptées au processus de déploiement de la boutique.

Mise à jour d’une installation existante

Si le module est déjà installé, mettez-le à jour via Composer :

composer update kowal/module-trustedus

Ensuite, exécutez :

php bin/magento setup:upgradephp bin/magento cache:flush

En mode production :

php bin/magento setup:upgrade --keep-generatedphp bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -fphp bin/magento cache:flush

Configuration dans le panneau d’administration

Accès à la liste des entreprises

Après l’installation, accédez dans le panneau Magento à :

Content -> Zaufali nam -> Firmy

Selon la configuration du menu, l’entrée peut aussi être disponible dans la section :

Trusted Us -> Firmy

Ajout d’une entreprise ou d’une étude de cas

Lors de l’ajout d’une nouvelle entrée, complétez les données de base :

• Nom de l’entreprise - nom du client, partenaire, fournisseur, marque ou projet.
• Adresse du site (URL) - adresse externe facultative ; actuellement, les widgets créent des liens internes si l’entrée dispose d’un slug de groupe défini.
• Groupe d’étude de cas / slug URL - slug global utilisé pour regrouper les entrées et construire le lien interne.
• Nom du projet - titre de la réalisation ou de l’étude de cas descriptive.
• Courte description du projet - contenu présenté avec l’entrée.
• Icône - logo de l’entreprise ou de la marque.
• Active - détermine si l’entrée est visible sur le frontend.
• Afficher dans le widget des entreprises mises en avant - détermine si l’entrée sera incluse dans le widget mis en avant.
• Ordre - tri des entrées.
• Products - produits associés à l’entrée.

Configuration du regroupement et des liens internes

Le champ Groupe d’étude de cas / slug URL sert à relier plusieurs entrées de la même entreprise sur une page interne unique.

Exemple :

vitcas

Toutes les entrées actives ayant le même slug seront visibles sur la page :

/trusted-us/vitcas

Si vous saisissez une valeur avec des espaces ou des majuscules, le module l’enregistrera comme slug sécurisé.

Exemple :

Tandem Baits

sera enregistré comme :

tandem-baits

Configuration des produits associés

Dans la section Produits / modules associés, sélectionnez les produits qui doivent être associés à l’entreprise, à la réalisation ou à l’étude de cas donnée.

Ces associations sont utilisées à deux endroits :

• sur la fiche produit, où le module peut afficher les entreprises ou réalisations associées,
• sur la page d’étude de cas /trusted-us/{slug}, où les produits sont présentés dans une grille similaire à celle des catégories de produits.

Configuration du widget standard

Dans l’édition d’une page CMS, de la page d’accueil, d’une landing page ou d’un bloc CMS, ajoutez le widget :

Kowal: Zaufali nam

Paramètres disponibles :

• Titre - titre de la section.
• Limite - nombre maximal d’entrées affichées.
• Afficher le nom du projet - indique si le nom du projet doit être visible sous le logo.

Si le champ group_slug est complété pour l’entrée, un clic sur le logo mène vers la page interne :

/trusted-us/{slug}

Si group_slug est vide, l’entrée reste sans lien.

Configuration du widget des entreprises mises en avant

Dans l’édition CMS, ajoutez le widget :

Kowal: Zaufali nam - wyróżnione firmy

Paramètres disponibles :

• En-tête - texte principal de la section.
• Limite - nombre maximal d’entrées affichées.

Le widget affiche uniquement les entrées actives qui ont l’option suivante cochée :

Pokaż w widgecie wyróżnionych firm

Comme le widget standard, il peut créer des liens vers les pages internes d’étude de cas sur la base du champ group_slug.

Section sur la fiche produit

Si des entreprises ou études de cas sont associées à un produit, le module peut afficher automatiquement une section sur la fiche produit.

La section présente :

• le logo de l’entreprise,
• le nom de l’entreprise,
• le nom du projet,
• une courte description du projet.

Cela permet de montrer l’utilisation réelle du produit et de renforcer la crédibilité de l’offre.

Pages d’étude de cas

Les pages d’étude de cas sont disponibles à l’adresse :

/trusted-us/{slug}

Exemple :

/trusted-us/vitcas

La page affiche :

• toutes les entrées actives ayant le même group_slug,
• les descriptions des études de cas,
• le logo de l’entreprise,
• les produits associés à chaque entrée,
• une grille de produits similaire à celle des catégories.

Ces pages augmentent le nombre de liens internes et créent un parcours supplémentaire :

widget -> case study -> produkt

Prise en charge de plusieurs store views

Le module prend en charge les contenus dépendants de la store view pour les champs :

• nom du projet,
• courte description du projet.

Les champs globaux, tels que le nom de l’entreprise, le logo, le statut d’activité, le tri, les produits associés et group_slug, sont communs à toute l’entrée.

Répertoire média

Les logos sont enregistrés dans le répertoire :

pub/media/kowal/trustedus/

Avant le déploiement, assurez-vous que le répertoire pub/media est correctement partagé ou synchronisé entre les environnements si la boutique fonctionne dans une architecture multi-serveurs.

Checklist de déploiement

Avant le déploiement :

• effectuez une sauvegarde de la base de données,
• effectuez une sauvegarde du code ou assurez-vous que le déploiement peut être reproduit depuis le dépôt,
• vérifiez l’accès au dépôt Composer,
• vérifiez le token GitHub s’il est requis,
• planifiez une fenêtre de déploiement si la boutique fonctionne en production.

Après le déploiement :

• exécutez setup:upgrade,
• nettoyez le cache,
• en mode production, exécutez la compilation DI et le déploiement du static content,
• vérifiez que le module est actif,
• ajoutez ou modifiez une entreprise de test,
• définissez group_slug,
• associez un produit,
• ajoutez un widget sur une page CMS de test,
• cliquez sur le logo et vérifiez la page /trusted-us/{slug},
• vérifiez que la grille de produits affiche les produits associés à l’étude de cas,
• vérifiez la fiche produit avec les entrées associées.

Commandes de diagnostic

Vérification du statut du module :

php bin/magento module:status Kowal_TrustedUs

Vérification de la liste des modules Kowal :

php bin/magento module:status | grep Kowal

Nettoyage du cache :

php bin/magento cache:flush

Nouvelle compilation DI :

php bin/magento setup:di:compile

Problèmes les plus fréquents

Le widget ne crée pas de lien vers la page d’étude de cas

Vérifiez que le champ suivant est complété pour l’entrée :

Grupa case study / slug URL

Un élément sans group_slug n’est pas lié à une page interne.

La page /trusted-us/{slug} ne fonctionne pas

Vérifiez :

• s’il existe une entrée active avec le group_slug donné,
• si setup:upgrade a été exécuté,
• si le cache a été nettoyé,
• si le module Kowal_TrustedUs est actif.

Les produits n’apparaissent pas sur la page d’étude de cas

Vérifiez :

• si les produits sont associés à l’entrée de l’entreprise,
• si les produits sont actifs,
• si les produits sont visibles dans le catalogue ou le moteur de recherche,
• si les produits sont disponibles dans la store view actuelle.

Les modifications ne sont pas visibles après le déploiement

Nettoyez le cache Magento :

php bin/magento cache:flush

En mode production, exécutez également :

php bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -f

Désinstallation

Désactivation du module :

php bin/magento module:disable Kowal_TrustedUsphp bin/magento setup:upgradephp bin/magento cache:flush

Suppression du package Composer :

composer remove kowal/module-trustedus

Avant de supprimer le module en production, il faut vérifier que la boutique n’utilise pas de widgets, blocs CMS ou contenus dépendants du module.