Configuración de la integración de GitHub con un tema de Guide

Acceso rápido: Administrador de Guide > Icono de personalizar diseño > Agregar tema > Agregar desde GitHub

La integración de GitHub le permite desarrollar y mantener un tema en colaboración con GitHub, y luego previsualizarlo o publicarlo en Guide. Para configurar la integración, asegúrese de que el tema esté guardado en GitHub y luego configure la integración en Guide.

Nota: La integración de GitHub con Guide no es compatible con GitHub Enterprise. Como alternativa, puede usar la API de temas de Guide.

Es necesario ser administrador de Guide para poder configurar la integración de GitHub en Guide.

En este artículo se tratan los siguientes temas:

• Preparar el tema en GitHub
• Configurar la integración

Preparar el tema en GitHub

Antes de configurar la integración en Guide, debe asegurarse de que el tema esté en GitHub. Si es la primera vez que usa Git y GitHub, consulte este tutorial. Si su tema ya está en GitHub y cumple los siguientes requisitos, consulte Configurar la integración.

La integración tiene los siguientes requisitos para el repositorio de GitHub:

• El archivo de manifiesto debe encontrarse en la raíz del repositorio de GitHub

  El archivo de manifiesto manifest.json se debe colocar en la raíz del repositorio de GitHub para que Guide pueda agregar el tema. Es posible incluir archivos adicionales (como los de herramientas), los cuales se omiten durante la importación en Guide.

• El repositorio de GitHub solo puede tener un tema

  Se debe administrar un solo tema en cada repositorio. Puede usar la opción de rama durante la importación del tema o probar variaciones del tema.

Para poner su tema en un repositorio de GithHub

• Si no tiene un tema, haga una bifurcación del repositorio del tema Copenhague y comience a crear el suyo propio. Esto le permitirá transferir mejoras fácilmente del tema Copenhague a su tema en un futuro.
• Si su tema se encuentra en Guide, descargue el tema desde Guide, luego cree un repositorio de GitHub (si aún no lo ha hecho) y haga un push de su tema al repositorio de GitHub.
• Si su tema no se encuentra en Guide o GitHub, cree un repositorio de GitHub (si aún no lo ha hecho) y haga un push de su tema al repositorio de GitHub.

Después de haber preparado su tema en GitHub, ya estará listo para configurar la integración en Guide.

Configurar la integración

Para configurar la integración de GitHub, asegúrese de que su tema esté guardado en GitHub, luego obtenga su tema de GithHub para dirigirlo a Guide. Esta obtención por única vez establece la conexión entre su tema y GithHub.

Una vez configurada la integración, trabajará en el tema en GithHub, y luego actualizará el tema en Guide cuando esté listo. En Guide, puede entonces previsualizar o publicar el tema en vivo.

Para configurar la integración de GitHub con el tema de Guide

1. En GithHub, asegúrese de haber preparado el tema.
2. En Guide, haga clic en el icono Personalizar diseño () en la barra lateral.

   Se abre la página Temas.

3. Haga clic en Agregar tema en la esquina superior derecha.
4. Haga clic en Agregar desde GitHub.

   

5. Ingrese el URL para el repositorio y, si lo desea, ingrese el nombre de su rama si quiere obtener de una rama que no sea la predeterminada, y luego haga clic en Importar.
6. Si se lo pide, inicie sesión en GithHub y luego haga clic en Authorize Zendesk.

La miniatura del tema aparece en la página Temas al terminar la importación. Si tiene problemas, consulte Resolución de problemas de la integración de GitHub para temas de Guide.

Una vez establecida la conexión entre su tema en Guide y GitHub, podrá administrar su tema en GitHub y actualizar el tema en Guide según se necesite.