Cuando los desarrolladores comprometen nuevo código o actualizaciones en un repositorio de GitHub, los cambios correspondientes a menudo deben reflejarse en tu base de conocimientos. Crear o actualizar manualmente artículos de Document360 para cada commit consume mucho tiempo y es propenso a errores. Al conectar GitHub y Document360 a través de Zapier, puedes automatizar esto: siempre que ocurra un evento específico en un repositorio de GitHub, Zapier crea automáticamente un artículo correspondiente en tu base de conocimientos de Document360.
Cuándo usar esta integración
- Tu equipo de ingeniería sigue un enfoque de docs-as-code y quiere que cada GitHub se comprometa en un repositorio específico para generar automáticamente un borrador de artículo en Document360 para su revisión.
- Mantienes un registro de cambios o una base de conocimiento de notas de lanzamiento en Document360 y quieres que nuevos commits o releases en GitHub activen automáticamente la creación de artículos.
- Tu flujo de trabajo de desarrollo incluye actualizaciones de documentación junto con cambios de código, y quieres asegurarte de que los artículos de la base de conocimiento se creen sincronizados sin un paso manual.
Antes de que empieces
- Debes estar conectado a tu cuenta de Zapier.
- Debes tener una cuenta de GitHub con acceso al repositorio que quieres monitorizar.
- Debes tener preparado tu token API de Document360. Para generar uno, navega a Conexiones > Extensiones, localiza la tesela de Zapier y haz clic en Conectar para copiar el token.
Cómo configurar el Zap
Paso 1 — Crear un nuevo Zap
- Inicia sesión en tu cuenta de Zapier.
- Desde el menú de navegación de la izquierda, haz clic en Crear y luego selecciona Zaps.
- Se crea una nueva descarga con un flujo de Disparador y Acción .
Paso 2 — Conecta GitHub como desencadenante
- En el campo Trigger , elige GitHub.
- En el campo de evento Trigger , selecciona el evento que debería activar la descarga.
NOTA
Para cambiar la aplicación de disparo más adelante, haz clic en Cambiar en el campo de Disparador.
- Haz clic en el campo Cuenta — aparece un panel de Inicio de sesión.
- Introduce tus credenciales de GitHub y haz clic en Autorizar Zapier.
- Elige el repositorio deseado y haz clic en Continuar. Zapier realiza una prueba para confirmar que el disparador está correctamente configurado.
Paso 3 — Conectar Document360 como la acción
- En el campo Acción , elige Document360.
- En el panel de Configuración, selecciona el evento deseado en el campo Evento .
- Haz clic en el campo Cuenta — aparece un panel de Inicio de sesión.
- Introduce tus credenciales de inicio de sesión y haz clic en Permitir.
Para generar el token API desde Document360:
- Navega a Conexiones > Extensiones en la barra de navegación izquierda del portal de la Base de conocimiento.
- En la casilla de extensión de Zapier , haz clic en Conectar.
- Haz clic en el icono de Copiar para copiar el token.
- Vuelve al panel de Zapier y pega el token de la API en el campo.
- Haz clic en sí, continuar con Document360.
- Puedes encontrar el proyecto Document360 conectado en la página de la cuenta Connect Document360 . Para usar otra cuenta más adelante, haz clic en Cambiar.
- Haz clic en continuar.
Paso 4 — Mapear los campos
- Mapea los campos de GitHub a Document360:
| Campo | Descripción |
|---|---|
| Título | Por defecto, se selecciona Nuevo Commit en GitHub . Hay otras opciones disponibles según tus necesidades. |
| Contenido | Por defecto, se selecciona Mensaje de Confirmación . Hay otras opciones disponibles según tus necesidades. |
| Versión | Elige el espacio de trabajo en tu proyecto Document360 donde deba crearse el artículo. |
| Idioma | Elige el idioma dentro del espacio de trabajo seleccionado. |
| Categoría | Selecciona la categoría donde se creará el artículo. |
| Publicar | Configura en Verdadero para publicar el artículo inmediatamente. Ponlo en Falso para guardarlo como borrador. |
NOTA
El botón Continuar solo se activa después de que se hayan asignado todos los campos necesarios.
- Haz clic en continuar.
Paso 5 — Probar y publicar el Zap
- En la sección de pruebas, haz clic en Enviar Prueba.
- Si tienes éxito, recibirás el mensaje que te enviará el Artículo de Prueba. Consulta tu cuenta de Document360 para verla.
- En tu portal Document360 encontrarás un nuevo artículo titulado "Nuevo commit en GitHub" en la categoría que has seleccionado.
- Vuelve al panel de configuración de Zapier y haz clic en Siguiente, luego en Publicar.
- Verás un mensaje de éxito: tu Zap está activado. Haz clic en Gestionar tu Zap para ir a la página de resumen de Zap.
Resumen de Zap
Una vez activado, puedes ver y gestionar el Zap desde el panel de control de Zapier. La página de resumen muestra el desencadenante, la acción y el historial de la carrera del Zap.
Cómo eliminar un Zap
- Navega hasta el panel de control de Zapier. Una lista de todos los Zaps existentes se muestra en la página de resumen.
- Haz clic en el icono de acciones de Zap () a la derecha del Zap que quieres eliminar y haz clic en Eliminar. El Zap se elimina permanentemente.
Mejores prácticas
- Configura el campo Publicar en False al mapear campos para que los artículos activados por GitHub lleguen a Document360 como borradores. Esto da a tu equipo de documentación la oportunidad de revisar, formatear y enriquecer el contenido antes de que se publique — ya que los mensajes de commit en bruto rara vez están listos para publicarse tal cual.
- Utiliza una categoría dedicada en Document360 para artículos activados por GitHub, como una categoría de "Registro de cambios" o "actualizaciones de desarrollo". Esto mantiene el contenido generado automáticamente separado de los artículos hechos a mano y facilita la revisión y la promoción.
- Elige un evento de disparo específico que se ajuste a tu flujo de trabajo — por ejemplo, un push a una rama de release en lugar de cada commit — para evitar generar artículos para cada cambio rutinario de código que no justifique una entrada en la base de conocimiento.