Aperçu des modifications des thèmes en local

Vous pouvez exporter les fichiers d’un thème de Guide et travailler dessus hors ligne dans l’éditeur de texte de votre choix. Pour éviter d’avoir à compresser et importer les fichiers dans Guide chaque fois que vous voulez voir un aperçu de vos modifications, vous pouvez consulter un aperçu de chaque modification dans votre navigateur Web en utilisant ZAT. Pour consulter l’aperçu d’une modification, il vous suffit d’enregistrer le fichier du thème dans votre éditeur de bureau et d’actualiser la page dans votre navigateur. Exemple :

ZAT est un groupe d’outils de développement qui inclut Sinatra, un serveur Web qui s’exécute en local sur votre ordinateur. Une fois le mode d’aperçu lancé, le processus s’exécute en arrière-plan.

Remarque – L’interface de ligne de commande Zendesk (ZCLI) remplace ZAT pour le développement des applications, mais ne prend pas en charge l’aperçu des thèmes Zendesk Guide pour l’instant.

Sujets abordés dans cet article :

• Configuration de l’aperçu du thème en local
• Lancement de l’aperçu du thème en local
• Aperçu des modifications

Configuration de l’aperçu du thème en local

Pour installer et utiliser ZAT, vous devez activer l’accès API et configurer un environnement de développement local.

Pour configurer l’aperçu du thème en local

1. Si ce n’est pas déjà fait, activez l’accès API dans votre compte Zendesk Support en allant à Admin > Canaux > API.
2. Installez ZAT. Consultez l’article sur l’Installation et l’utilisation de ZAT dans la documentation pour les développeurs Zendesk. Puis revenez ici.
3. Mettez ZAT à jour en exécutant la commande suivante dans le terminal de votre ordinateur.

   gem update zendesk_apps_tools

Lancement de l’aperçu du thème en local

Lancez l’aperçu du thème en local avant de commencer à travailler sur les fichiers du thème sur votre ordinateur.

Pour lancer l’aperçu du thème en local

1. Dans le terminal de votre ordinateur, naviguez jusqu’au dossier contenant les fichiers du thème exportés et compressés. Exemple :

   cd guide_themes/newlook_theme

2. Exécutez la commande suivante :

   zat theme preview 

3. À l’invite, saisissez votre sous-domaine Zendesk, ainsi que l’adresse e-mail et le mot de passe que vous utilisez pour vous connecter à Zendesk Guide.

   

   Si vous utilisez la connexion unique pour vous connecter à Guide, vous pouvez vous connecter en utilisant un token API. Consultez Token API dans la documentation de l’API REST. Quand ZAT vous invite à vous connecter, saisissez {votre_email}/token comme nom d’utilisateur (« /token » étant la chaîne « /token » telle quelle). Utilisez le token API comme mot de passe. Exemple :

   Enter your username: [e-mail]/token
   Enter your password: e8Pvy0pvGzE8meUQxWgjIYkjr

   Une fois que vous êtes connecté, le mode d’aperçu est lancé et s’exécute en arrière-plan :

   

4. Copiez l’URL « Ready » dans la sortie et collez-la dans un navigateur Web, comme Chrome ou Firefox. Le navigateur doit autoriser un contenu HTTP et HTTPS mixte. Safari ne prend pas en charge le contenu mixte et ne vous permettra pas d’afficher l’aperçu des thèmes en local.

   Dans l’exemple, l’URL « Ready » est https://z3n-example.zendesk.com/hc/admin/local_preview/start.

   L’URL devrait charger l’aperçu du thème.

Aperçu des modifications

Une fois le mode d’aperçu du thème lancé, vous pouvez travailler sur les fichiers du thème en local, dans votre éditeur de texte. Travaillez de façon itérative pour développer et tester votre thème. Par exemple, apportez des modifications à votre code JavaScript, enregistrez-les et actualisez la page de navigateur pour tester ces modifications.

Pour consulter l’aperçu des modifications

1. Enregistrez le fichier modifié dans votre éditeur de texte.
2. Actualisez la page dans le navigateur.

Quand vous avez terminé, vous pouvez arrêter le mode d’aperçu en utilisant l’une des méthodes suivantes :

• Dans la session de terminal dans laquelle s’exécute ZAT, appuyez sur Ctrl+C.
• En haut de la page d’aperçu du thème du navigateur, cliquez sur le lien Fermer l’aperçu.