Istruzioni di installazione, configurazione e implementazione del modulo Kowal TrustedUs
Obiettivo del modulo
Kowal TrustedUs è un modulo Magento 2 universale per presentare aziende, clienti, partner, fornitori, brand e case study nel negozio.
Il modulo può essere utilizzato come:
- sezione 'Si sono fidati di noi',
- elenco di partner o fornitori,
- portfolio di realizzazioni,
- database di case study,
- sezione che mostra gli utilizzi dei prodotti,
- strumento per rafforzare il linking interno nel negozio.
Dopo l'ultima espansione, i widget possono portare a pagine interne di case study, ad esempio:
/trusted-us/vitcas
In questa pagina vengono visualizzate le voci dello stesso gruppo e i prodotti a esse assegnati.
Requisiti
Prima dell'installazione assicurati che il negozio soddisfi i requisiti:
- funzioni su Magento 2,
- abbia accesso a Composer,
- abbia accesso al repository del modulo,
- abbia configurato un token GitHub, se il repository è privato,
- possa eseguire i comandi
bin/magento, - abbia un backup del codice e del database prima dell'implementazione in produzione.
Installazione tramite Composer
1. Aggiunta del repository Composer
Nella directory principale di Magento esegui:
composer config repositories.kowal.trusted.us vcs https://github.com/kowalco/trusted-us
2. Aggiunta del token di accesso
Se il repository è privato, aggiungi il token GitHub:
composer config --global --auth github-oauth.github.com
3. Installazione del modulo
composer require kowal/module-trustedus
4. Attivazione del modulo
Nome del modulo Magento:
Kowal_TrustedUs
Attiva il modulo:
php bin/magento module:enable Kowal_TrustedUs
5. Aggiornamento dello schema del database
php bin/magento setup:upgrade
Questo comando creerà o aggiornerà le tabelle del modulo, incluso il campo group_slug usato per le pagine interne dei case study.
6. Pulizia della cache
php bin/magento cache:flush
Installazione in modalità produzione
Nell'ambiente di produzione è consigliato il processo standard di deployment Magento.
Sequenza di esempio:
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
Se il negozio ha una propria pipeline CI/CD, i passaggi sopra indicati devono essere adattati al processo di deployment del negozio.
Aggiornamento di un'installazione esistente
Se il modulo è già installato, aggiornalo tramite Composer:
composer update kowal/module-trustedus
Quindi esegui:
php bin/magento setup:upgradephp bin/magento cache:flush
In modalità produzione:
php bin/magento setup:upgrade --keep-generatedphp bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -fphp bin/magento cache:flush
Configurazione nel pannello di amministrazione
Accesso all'elenco delle aziende
Dopo l'installazione vai nel pannello Magento a:
Content -> Zaufali nam -> Firmy
A seconda della configurazione del menu, la voce può essere disponibile anche nella sezione:
Trusted Us -> Firmy
Aggiunta di un'azienda o di un case study
Quando aggiungi una nuova voce, completa i dati di base:
- Nome dell'azienda - nome del cliente, partner, fornitore, brand o progetto.
- Indirizzo del sito (URL) - indirizzo esterno opzionale; attualmente i widget linkano internamente se la voce ha impostato lo slug del gruppo.
- Gruppo case study / slug URL - slug globale usato per raggruppare le voci e creare il link interno.
- Nome del progetto - titolo della realizzazione o del case study descrittivo.
- Breve descrizione del progetto - contenuto presentato accanto alla voce.
- Icona - logo dell'azienda o del brand.
- Attiva - determina se la voce è visibile sul frontend.
- Mostra nel widget delle aziende in evidenza - determina se la voce verrà inclusa nel widget in evidenza.
- Ordine - ordinamento delle voci.
- Products - prodotti associati alla voce.
Configurazione del raggruppamento e dei link interni
Il campo Gruppo case study / slug URL serve a collegare più voci della stessa azienda in un'unica pagina interna.
Esempio:
vitcas
Tutte le voci attive con lo stesso slug saranno visibili nella pagina:
/trusted-us/vitcas
Se inserisci un valore con spazi o lettere maiuscole, il modulo lo salverà come slug sicuro.
Esempio:
Tandem Baits
verrà salvato come:
tandem-baits
Configurazione dei prodotti associati
Nella sezione Prodotti / moduli associati seleziona i prodotti che devono essere assegnati a una determinata azienda, realizzazione o case study.
Queste associazioni vengono usate in due punti:
- nella scheda prodotto, dove il modulo può mostrare aziende o realizzazioni associate,
- nella pagina del case study
/trusted-us/{slug}, dove i prodotti sono presentati in una griglia simile a quella delle categorie prodotto.
Nella modifica della pagina CMS, della home page, della landing page o del blocco CMS aggiungi il widget:
Kowal: Zaufali nam
Parametri disponibili:
- Titolo - intestazione della sezione.
- Limite - numero massimo di voci visualizzate.
- Mostra nome del progetto - indica se il nome del progetto deve essere visibile sotto il logo.
Se la voce ha il campo group_slug compilato, il clic sul logo porta alla pagina interna:
/trusted-us/{slug}
Se group_slug è vuoto, la voce rimane senza link.
Nella modifica CMS aggiungi il widget:
Kowal: Zaufali nam - wyróżnione firmy
Parametri disponibili:
- Intestazione - testo principale della sezione.
- Limite - numero massimo di voci visualizzate.
Il widget mostra solo le voci attive che hanno selezionato:
Pokaż w widgecie wyróżnionych firm
Come il widget standard, può linkare alle pagine interne dei case study in base al campo group_slug.
Sezione nella scheda prodotto
Se al prodotto sono assegnate aziende o case study, il modulo può mostrare automaticamente una sezione nella scheda prodotto.
La sezione presenta:
- logo dell'azienda,
- nome dell'azienda,
- nome del progetto,
- breve descrizione del progetto.
Questo consente di mostrare l'utilizzo reale del prodotto e rafforzare la credibilità dell'offerta.
Pagine dei case study
Le pagine dei case study sono disponibili all'indirizzo:
/trusted-us/{slug}
Esempio:
/trusted-us/vitcas
Nella pagina vengono visualizzati:
- tutte le voci attive con lo stesso
group_slug, - descrizioni dei case study,
- logo dell'azienda,
- prodotti assegnati a ogni voce,
- griglia dei prodotti simile alla griglia di categoria.
Queste pagine aumentano il numero di link interni e creano un percorso aggiuntivo:
widget -> case study -> produkt
Supporto di più store view
Il modulo supporta contenuti dipendenti dalla store view per i campi:
- nome del progetto,
- breve descrizione del progetto.
I campi globali, come nome dell'azienda, logo, stato di attività, ordinamento, prodotti associati e group_slug, sono comuni all'intera voce.
Directory media
I loghi vengono salvati nella directory:
pub/media/kowal/trustedus/
Prima del deployment assicurati che la directory pub/media sia correttamente condivisa o sincronizzata tra gli ambienti, se il negozio opera in un'architettura multi-server.
Checklist di deployment
Prima del deployment:
- esegui il backup del database,
- esegui il backup del codice o assicurati che il deployment sia riproducibile dal repository,
- verifica l'accesso al repository Composer,
- verifica il token GitHub, se richiesto,
- pianifica una finestra di deployment, se il negozio è in produzione.
Dopo il deployment:
- esegui
setup:upgrade, - pulisci la cache,
- in modalità produzione esegui la compilazione DI e il deployment dello static content,
- verifica che il modulo sia attivo,
- aggiungi o modifica un'azienda di test,
- imposta
group_slug, - assegna un prodotto,
- aggiungi il widget in una pagina CMS di test,
- clicca sul logo e verifica la pagina
/trusted-us/{slug}, - controlla se la griglia dei prodotti visualizza i prodotti assegnati al case study,
- verifica la scheda prodotto con le voci assegnate.
Comandi diagnostici
Verifica dello stato del modulo:
php bin/magento module:status Kowal_TrustedUs
Verifica dell'elenco dei moduli Kowal:
php bin/magento module:status | grep Kowal
Pulizia della cache:
php bin/magento cache:flush
Ricomplilazione DI:
php bin/magento setup:di:compile
Problemi più comuni
Verifica che la voce abbia compilato il campo:
Grupa case study / slug URL
Un elemento senza group_slug non viene linkato alla pagina interna.
La pagina /trusted-us/{slug} non funziona
Verifica:
- se esiste una voce attiva con il relativo
group_slug, - se è stato eseguito
setup:upgrade, - se la cache è stata pulita,
- se il modulo
Kowal_TrustedUs è attivo.
I prodotti non compaiono nella pagina del case study
Verifica:
- se i prodotti sono assegnati alla voce dell'azienda,
- se i prodotti sono attivi,
- se i prodotti sono visibili nel catalogo o nel motore di ricerca,
- se i prodotti sono disponibili nella store view corrente.
Le modifiche non sono visibili dopo il deployment
Pulisci la cache Magento:
php bin/magento cache:flush
In modalità produzione esegui anche:
php bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -f
Disinstallazione
Disattivazione del modulo:
php bin/magento module:disable Kowal_TrustedUsphp bin/magento setup:upgradephp bin/magento cache:flush
Rimozione del pacchetto Composer:
composer remove kowal/module-trustedus
Prima di rimuovere il modulo dalla produzione è necessario verificare che il negozio non utilizzi widget, blocchi CMS o contenuti dipendenti dal modulo.