Handleiding voor installatie, configuratie en implementatie van de module Kowal TrustedUs
Doel van de module
Kowal TrustedUs is een universele Magento 2-module voor het presenteren van bedrijven, klanten, partners, leveranciers, merken en case studies in de winkel.
De module kan worden gebruikt als:
- sectie 'Vertrouwd door',
- lijst met partners of leveranciers,
- portfolio van realisaties,
- database met case studies,
- sectie die toepassingen van producten toont,
- tool die interne linking in de winkel versterkt.
Na de nieuwste uitbreiding kunnen widgets naar interne case study-pagina's leiden, bijvoorbeeld:
/trusted-us/vitcas
Op zo'n pagina worden items uit dezelfde groep en de daaraan gekoppelde producten weergegeven.
Vereisten
Controleer vóór installatie of de winkel aan de vereisten voldoet:
- draait op Magento 2,
- heeft toegang tot Composer,
- heeft toegang tot de repository van de module,
- heeft een GitHub-token geconfigureerd als de repository privé is,
- kan
bin/magento-commando's uitvoeren, - heeft een back-up van code en database gemaakt vóór productie-implementatie.
Installatie via Composer
1. Composer-repository toevoegen
Voer in de hoofdmap van Magento uit:
composer config repositories.kowal.trusted.us vcs https://github.com/kowalco/trusted-us
2. Toegangstoken toevoegen
Als de repository privé is, voeg dan een GitHub-token toe:
composer config --global --auth github-oauth.github.com
3. Module installeren
composer require kowal/module-trustedus
4. Module inschakelen
Naam van de Magento-module:
Kowal_TrustedUs
Schakel de module in:
php bin/magento module:enable Kowal_TrustedUs
5. Databaseschema bijwerken
php bin/magento setup:upgrade
Dit commando maakt de moduletabellen aan of werkt ze bij, inclusief het veld group_slug dat wordt gebruikt voor interne case study-pagina's.
6. Cache legen
php bin/magento cache:flush
Installatie in productiemodus
Op een productieomgeving wordt het standaard Magento-implementatieproces aanbevolen.
Voorbeeldvolgorde:
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
Als de winkel een eigen CI/CD-pipeline heeft, moeten bovenstaande stappen worden afgestemd op het implementatieproces van de winkel.
Bestaande installatie bijwerken
Als de module al is geïnstalleerd, werk deze dan bij via Composer:
composer update kowal/module-trustedus
Voer daarna uit:
php bin/magento setup:upgradephp bin/magento cache:flush
In productiemodus:
php bin/magento setup:upgrade --keep-generatedphp bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -fphp bin/magento cache:flush
Configuratie in het beheerpaneel
Naar de bedrijvenlijst gaan
Ga na installatie in het Magento-paneel naar:
Content -> Zaufali nam -> Firmy
Afhankelijk van de menuconfiguratie kan het item ook beschikbaar zijn in de sectie:
Trusted Us -> Firmy
Een bedrijf of case study toevoegen
Vul bij het toevoegen van een nieuw item de basisgegevens in:
- Bedrijfsnaam - naam van de klant, partner, leverancier, het merk of project.
- Websiteadres (URL) - optioneel extern adres; momenteel linken widgets intern als voor het item een groepsslug is ingesteld.
- Case study-groep / URL-slug - globale slug die wordt gebruikt om items te groeperen en de interne link op te bouwen.
- Projectnaam - titel van de realisatie of beschrijvende case study.
- Korte projectbeschrijving - content die bij het item wordt weergegeven.
- Icoon - logo van het bedrijf of merk.
- Actief - bepaalt of het item zichtbaar is op de frontend.
- Toon in widget voor uitgelichte bedrijven - bepaalt of het item in de uitgelichte widget terechtkomt.
- Volgorde - sortering van items.
- Products - producten die aan het item zijn gekoppeld.
Configuratie van groepering en interne links
Het veld Case study-groep / URL-slug wordt gebruikt om meerdere items van hetzelfde bedrijf op één interne pagina te combineren.
Voorbeeld:
vitcas
Alle actieve items met dezelfde slug zijn zichtbaar op de pagina:
/trusted-us/vitcas
Als u een waarde met spaties of hoofdletters invoert, slaat de module deze op als een veilige slug.
Voorbeeld:
Tandem Baits
wordt opgeslagen als:
tandem-baits
Configuratie van gerelateerde producten
Selecteer in de sectie Gerelateerde producten / modules de producten die aan een bepaald bedrijf, een bepaalde realisatie of case study moeten worden gekoppeld.
Deze koppelingen worden op twee plaatsen gebruikt:
- op de productpagina, waar de module gerelateerde bedrijven of realisaties kan tonen,
- op de case study-pagina
/trusted-us/{slug}, waar producten worden gepresenteerd in een raster dat lijkt op een categorieraster.
Voeg bij het bewerken van een CMS-pagina, homepage, landing page of CMS-blok de widget toe:
Kowal: Zaufali nam
Beschikbare parameters:
- Titel - kop van de sectie.
- Limiet - maximaal aantal weergegeven items.
- Toon projectnaam - of de projectnaam onder het logo zichtbaar moet zijn.
Als voor het item het veld group_slug is ingevuld, leidt een klik op het logo naar de interne pagina:
/trusted-us/{slug}
Als group_slug leeg is, blijft het item zonder link.
Voeg bij het bewerken van CMS de widget toe:
Kowal: Zaufali nam - wyróżnione firmy
Beschikbare parameters:
- Kop - hoofdtekst van de sectie.
- Limiet - maximaal aantal weergegeven items.
De widget toont alleen actieve items waarvoor is aangevinkt:
Pokaż w widgecie wyróżnionych firm
Net als de standaardwidget kan deze op basis van het veld group_slug linken naar interne case study-pagina's.
Sectie op de productpagina
Als aan een product bedrijven of case studies zijn gekoppeld, kan de module automatisch een sectie op de productpagina tonen.
De sectie presenteert:
- bedrijfslogo,
- bedrijfsnaam,
- projectnaam,
- korte projectbeschrijving.
Dit maakt het mogelijk om het daadwerkelijke gebruik van het product te tonen en de geloofwaardigheid van het aanbod te versterken.
Case study-pagina's
Case study-pagina's zijn beschikbaar op het adres:
/trusted-us/{slug}
Voorbeeld:
/trusted-us/vitcas
Op de pagina worden weergegeven:
- alle actieve items met dezelfde
group_slug, - beschrijvingen van case studies,
- bedrijfslogo,
- producten die aan elk item zijn gekoppeld,
- productraster dat lijkt op het categorieraster.
Deze pagina's vergroten het aantal interne links en creëren een extra pad:
widget -> case study -> produkt
Ondersteuning voor meerdere store views
De module ondersteunt store view-afhankelijke content voor de velden:
- projectnaam,
- korte projectbeschrijving.
Globale velden, zoals bedrijfsnaam, logo, activiteitsstatus, sortering, gekoppelde producten en group_slug, zijn gemeenschappelijk voor het volledige item.
Mediamap
Logo's worden opgeslagen in de map:
pub/media/kowal/trustedus/
Controleer vóór implementatie of de map pub/media correct wordt gedeeld of gesynchroniseerd tussen omgevingen als de winkel in een multiserverarchitectuur werkt.
Implementatiechecklist
Vóór implementatie:
- maak een back-up van de database,
- maak een back-up van de code of controleer of de implementatie vanuit de repository reproduceerbaar is,
- controleer toegang tot de Composer-repository,
- controleer de GitHub-token als deze vereist is,
- plan een implementatievenster als de winkel in productie draait.
Na implementatie:
- voer
setup:upgrade uit, - leeg de cache,
- voer in productiemodus DI-compilatie en static content deployment uit,
- controleer of de module actief is,
- voeg een testbedrijf toe of bewerk er een,
- stel
group_slug in, - koppel een product,
- voeg een widget toe op een test-CMS-pagina,
- klik op het logo en controleer de pagina
/trusted-us/{slug}, - controleer of het productraster producten toont die aan de case study zijn gekoppeld,
- controleer de productpagina met gekoppelde items.
Diagnostische commando's
Status van de module controleren:
php bin/magento module:status Kowal_TrustedUs
Lijst met Kowal-modules controleren:
php bin/magento module:status | grep Kowal
Cache legen:
php bin/magento cache:flush
DI opnieuw compileren:
php bin/magento setup:di:compile
Meest voorkomende problemen
Controleer of voor het item het veld is ingevuld:
Grupa case study / slug URL
Een element zonder group_slug wordt niet naar de interne pagina gelinkt.
Pagina /trusted-us/{slug} werkt niet
Controleer:
- of er een actief item met de betreffende
group_slug bestaat, - of
setup:upgrade is uitgevoerd, - of de cache is geleegd,
- of de module
Kowal_TrustedUs actief is.
Producten verschijnen niet op de case study-pagina
Controleer:
- of producten aan het bedrijfsitem zijn gekoppeld,
- of producten actief zijn,
- of producten zichtbaar zijn in de catalogus of zoekmachine,
- of producten beschikbaar zijn in de huidige store view.
Wijzigingen zijn na implementatie niet zichtbaar
Leeg de Magento-cache:
php bin/magento cache:flush
Voer in productiemodus ook uit:
php bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -f
Deïnstallatie
Module uitschakelen:
php bin/magento module:disable Kowal_TrustedUsphp bin/magento setup:upgradephp bin/magento cache:flush
Composer-pakket verwijderen:
composer remove kowal/module-trustedus
Controleer vóór het verwijderen van de module uit productie of de winkel geen gebruikmaakt van widgets, CMS-blokken of content die afhankelijk is van de module.