Anleitung zur Installation, Konfiguration und Implementierung des Moduls Kowal TrustedUs

Ziel des Moduls

Kowal TrustedUs ist ein universelles Magento-2-Modul zur Präsentation von Unternehmen, Kunden, Partnern, Lieferanten, Marken und Case Studies im Shop.

Das Modul kann verwendet werden als:

• Sektion 'Sie vertrauen uns',
• Liste von Partnern oder Lieferanten,
• Referenzportfolio,
• Case-Study-Datenbank,
• Sektion zur Darstellung von Produktanwendungen,
• Tool zur Stärkung der internen Verlinkung im Shop.

Nach der neuesten Erweiterung können Widgets zu internen Case-Study-Seiten führen, z. B.:

/trusted-us/vitcas

Auf einer solchen Seite werden Einträge aus derselben Gruppe sowie die ihnen zugeordneten Produkte angezeigt.

Anforderungen

Stellen Sie vor der Installation sicher, dass der Shop die Anforderungen erfüllt:

• läuft auf Magento 2,
• hat Zugriff auf Composer,
• hat Zugriff auf das Modul-Repository,
• hat ein konfiguriertes GitHub-Token, falls das Repository privat ist,
• kann Befehle bin/magento ausführen,
• hat vor der Produktivimplementierung ein Backup des Codes und der Datenbank erstellt.

Installation über Composer

1. Composer-Repository hinzufügen

Führen Sie im Magento-Stammverzeichnis aus:

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

2. Zugriffstoken hinzufügen

Wenn das Repository privat ist, fügen Sie ein GitHub-Token hinzu:

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

3. Installation des Moduls

composer require kowal/module-trustedus

4. Modul aktivieren

Name des Magento-Moduls:

Kowal_TrustedUs

Aktivieren Sie das Modul:

php bin/magento module:enable Kowal_TrustedUs

5. Aktualisierung des Datenbankschemas

php bin/magento setup:upgrade

Dieser Befehl erstellt oder aktualisiert die Tabellen des Moduls, einschließlich des Feldes group_slug für interne Case-Study-Seiten.

6. Cache leeren

php bin/magento cache:flush

Installation im Produktionsmodus

In der Produktionsumgebung wird der standardmäßige Magento-Deployment-Prozess empfohlen.

Beispielsequenz:

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

Wenn der Shop über eine eigene CI/CD-Pipeline verfügt, sollten die obigen Schritte an den Deployment-Prozess des Shops angepasst werden.

Aktualisierung einer bestehenden Installation

Wenn das Modul bereits installiert ist, aktualisieren Sie es über Composer:

composer update kowal/module-trustedus

Führen Sie anschließend aus:

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

Im Produktionsmodus:

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

Konfiguration im Adminbereich

Zur Unternehmensliste wechseln

Gehen Sie nach der Installation im Magento-Adminbereich zu:

Content -> Zaufali nam -> Firmy

Je nach Menükonfiguration kann der Eintrag auch in folgender Sektion verfügbar sein:

Trusted Us -> Firmy

Unternehmen oder Case Study hinzufügen

Beim Hinzufügen eines neuen Eintrags ergänzen Sie die Basisdaten:

• Unternehmensname - Name des Kunden, Partners, Lieferanten, der Marke oder des Projekts.
• Website-Adresse (URL) - optionale externe Adresse; derzeit verlinken Widgets intern, wenn für den Eintrag ein Gruppen-Slug gesetzt ist.
• Case-Study-Gruppe / URL-Slug - globaler Slug, der zum Gruppieren von Einträgen und zum Aufbau des internen Links verwendet wird.
• Projektname - Titel der Referenz oder beschreibenden Case Study.
• Kurze Projektbeschreibung - Inhalt, der beim Eintrag angezeigt wird.
• Icon - Logo des Unternehmens oder der Marke.
• Aktiv - legt fest, ob der Eintrag im Frontend sichtbar ist.
• Im Widget für hervorgehobene Unternehmen anzeigen - legt fest, ob der Eintrag im hervorgehobenen Widget erscheint.
• Reihenfolge - Sortierung der Einträge.
• Products - Produkte, die mit dem Eintrag verknüpft sind.

Konfiguration der Gruppierung und internen Links

Das Feld Case-Study-Gruppe / URL-Slug dient dazu, mehrere Einträge desselben Unternehmens auf einer internen Seite zusammenzuführen.

Beispiel:

vitcas

Alle aktiven Einträge mit demselben Slug sind auf folgender Seite sichtbar:

/trusted-us/vitcas

Wenn Sie einen Wert mit Leerzeichen oder Großbuchstaben eingeben, speichert das Modul ihn als sicheren Slug.

Beispiel:

Tandem Baits

wird gespeichert als:

tandem-baits

Konfiguration verknüpfter Produkte

W der Sektion Verknüpfte Produkte / Module wählen Sie Produkte aus, die dem jeweiligen Unternehmen, der Referenz oder der Case Study zugeordnet werden sollen.

Diese Verknüpfungen werden an zwei Stellen verwendet:

• auf der Produktseite, wo das Modul zugehörige Unternehmen oder Referenzen anzeigen kann,
• auf der Case-Study-Seite /trusted-us/{slug}, wo Produkte in einem Raster ähnlich dem Kategorieraster präsentiert werden.

Konfiguration des Standard-Widgets

Fügen Sie bei der Bearbeitung einer CMS-Seite, der Startseite, Landing Page oder eines CMS-Blocks das Widget hinzu:

Kowal: Zaufali nam

Verfügbare Parameter:

• Titel - Überschrift der Sektion.
• Limit - maximale Anzahl der angezeigten Einträge.
• Projektname anzeigen - ob unter dem Logo der Projektname sichtbar sein soll.

Wenn für den Eintrag das Feld group_slug ausgefüllt ist, führt ein Klick auf das Logo zur internen Seite:

/trusted-us/{slug}

Wenn group_slug leer ist, bleibt der Eintrag ohne Link.

Konfiguration des Widgets für hervorgehobene Unternehmen

Fügen Sie in der CMS-Bearbeitung das Widget hinzu:

Kowal: Zaufali nam - wyróżnione firmy

Verfügbare Parameter:

• Überschrift - Haupttext der Sektion.
• Limit - maximale Anzahl der angezeigten Einträge.

Das Widget zeigt nur aktive Einträge an, bei denen Folgendes markiert ist:

Pokaż w widgecie wyróżnionych firm

Genau wie das Standard-Widget kann es anhand des Feldes group_slug auf interne Case-Study-Seiten verlinken.

Sektion auf der Produktseite

Wenn einem Produkt Unternehmen oder Case Studies zugeordnet sind, kann das Modul automatisch eine Sektion auf der Produktseite anzeigen.

Die Sektion präsentiert:

• Unternehmenslogo,
• Unternehmensname,
• Projektname,
• kurze Projektbeschreibung.

So kann die reale Nutzung des Produkts gezeigt und die Glaubwürdigkeit des Angebots gestärkt werden.

Case-Study-Seiten

Case-Study-Seiten sind unter folgender Adresse verfügbar:

/trusted-us/{slug}

Beispiel:

/trusted-us/vitcas

Auf der Seite werden angezeigt:

• alle aktiven Einträge mit demselben group_slug,
• Beschreibungen der Case Studies,
• Unternehmenslogo,
• Produkte, die jedem Eintrag zugeordnet sind,
• ein Produktraster ähnlich dem Kategorieraster.

Diese Seiten erhöhen die Anzahl interner Links und schaffen einen zusätzlichen Pfad:

widget -> case study -> produkt

Unterstützung mehrerer Store Views

Das Modul unterstützt Inhalte abhängig vom Store View für folgende Felder:

• Projektname,
• kurze Projektbeschreibung.

Globale Felder, wie Unternehmensname, Logo, Aktivitätsstatus, Sortierung, verknüpfte Produkte und group_slug, gelten für den gesamten Eintrag.

Medienverzeichnis

Logos werden im folgenden Verzeichnis gespeichert:

pub/media/kowal/trustedus/

Stellen Sie vor der Implementierung sicher, dass das Verzeichnis pub/media korrekt zwischen Umgebungen geteilt oder synchronisiert wird, wenn der Shop in einer Mehrserver-Architektur läuft.

Deployment-Checkliste

Vor der Implementierung:

• erstellen Sie ein Backup der Datenbank,
• erstellen Sie ein Backup des Codes oder stellen Sie sicher, dass das Deployment aus dem Repository reproduzierbar ist,
• prüfen Sie den Zugriff auf das Composer-Repository,
• prüfen Sie das GitHub-Token, falls erforderlich,
• planen Sie ein Deployment-Fenster, wenn der Shop produktiv läuft.

Nach der Implementierung:

• führen Sie setup:upgrade aus,
• leeren Sie den Cache,
• führen Sie im Produktionsmodus die DI-Kompilierung und das Deployment von Static Content aus,
• prüfen Sie, ob das Modul aktiv ist,
• fügen Sie ein Testunternehmen hinzu oder bearbeiten Sie es,
• setzen Sie group_slug,
• ordnen Sie ein Produkt zu,
• fügen Sie das Widget auf einer Test-CMS-Seite hinzu,
• klicken Sie auf das Logo und prüfen Sie die Seite /trusted-us/{slug},
• prüfen Sie, ob das Produktraster die der Case Study zugeordneten Produkte anzeigt,
• prüfen Sie die Produktseite mit zugeordneten Einträgen.

Diagnosebefehle

Prüfung des Modulstatus:

php bin/magento module:status Kowal_TrustedUs

Prüfung der Liste der Kowal-Module:

php bin/magento module:status | grep Kowal

Cache leeren:

php bin/magento cache:flush

DI erneut kompilieren:

php bin/magento setup:di:compile

Häufige Probleme

Widget verlinkt nicht zur Case-Study-Seite

Prüfen Sie, ob beim Eintrag das Feld ausgefüllt ist:

Grupa case study / slug URL

Ein Element ohne group_slug wird nicht mit einer internen Seite verlinkt.

Seite /trusted-us/{slug} funktioniert nicht

Prüfen Sie:

• ob ein aktiver Eintrag mit dem jeweiligen group_slug existiert,
• ob setup:upgrade ausgeführt wurde,
• ob der Cache geleert wurde,
• ob das Modul Kowal_TrustedUs aktiv ist.

Produkte erscheinen nicht auf der Case-Study-Seite

Prüfen Sie:

• ob Produkte dem Unternehmenseintrag zugeordnet sind,
• ob die Produkte aktiv sind,
• ob die Produkte im Katalog oder in der Suche sichtbar sind,
• ob die Produkte im aktuellen Store View verfügbar sind.

Änderungen sind nach der Implementierung nicht sichtbar

Leeren Sie den Magento-Cache:

php bin/magento cache:flush

Führen Sie im Produktionsmodus zusätzlich aus:

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

Deinstallation

Modul deaktivieren:

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

Composer-Paket entfernen:

composer remove kowal/module-trustedus

Vor dem Entfernen des Moduls aus der Produktion muss geprüft werden, ob der Shop keine Widgets, CMS-Blöcke oder vom Modul abhängigen Inhalte verwendet.