Planes que admiten esta función: Business Enterprise
Con la integración Document360 y GitHub , tu equipo puede vincular sin problemas los artículos de la Knowledge Base con los GitHub , permitiendo una mejor colaboración entre desarrolladores y redactores técnicos. Puedes hacer un seguimiento de actualizaciones, asociar tareas de documentación con cambios de código y asegurarte de que tu base de conocimiento se mantenga sincronizada con tu proceso de desarrollo, todo ello sin cambiar entre plataformas.
Configurando GitHub en Document360
Para configurar GitHub en Document360,
Navega a Conexiones () > Extensiones en la barra de navegación izquierda del portal de la base de conocimiento.
Puedes encontrar la extensión GitHub en la sección Repositorios de código .
Haz Conectar en la casilla de extensión.
Se abrirá un nuevo panel de instalación.
Selecciona una de las dos opciones según tus necesidades:
Todos los repositorios: elige sincronizar todos los repositorios.
Solo selecciona repositorios: elige sincronizar los específicos según los requisitos de tu proyecto.
Haz Instalar.
Si no has iniciado sesión en GitHub, serás redirigido a la pantalla de inicio de sesión.
Introduce tus credenciales GitHub y inicia sesión. Serás redirigido al Knowledge base portal Document360. Aparecerá el módulo Crear nueva categoría.
Selecciona GitHub () como tipo de categoría. Selecciona el repositorio desde tu GitHub configurado.
Aparecerá un cuadro de confirmación que dice 'Tu GitHub ha sido iniciado con éxito'.
La categoría de repositorio, junto con todas las ramas, se crea como artículos en Document360. Cada vez que un usuario GitHub actualiza el repositorio, el contenido se sincroniza con los artículos Document360 .
Puedes identificar cada entidad en Document360 en la categoría GitHub mediante un icono de rama ().
Configuración de un repositorio Git
Para configurar un repositorio Git para el acceso a contenido en Document360,
Asegúrate de que tu repositorio Git esté correctamente configurado y configurado para permitir la obtención del contenido en el proyecto Document360. Sigue la estructura a continuación:
Carpeta principal:
En GitHub, el repositorio debe incluir una carpeta principal llamada
docsdonde puedas organizar subcarpetas y artículos de Markdown.El nombre de esta carpeta debe permanecer sin cambios.
Almacenamiento de archivos multimedia:
Guarda todos los archivos multimedia dentro de la
.document360/assetscarpeta dentro deldocsdirectorio.El nombre de esta carpeta debe permanecer sin cambios.
Por ejemplo, si una imagen está referenciada en un archivo llamado 'What is Document360', debe moverse a la
.document360/assetscarpeta.
Almacenamiento de artículos:Dentro de la
docscarpeta, crea un directorio separado, por ejemplo,articlespara almacenar tus artículos.Los artículos deben estar en formato Markdown (.md).
Insertar archivos multimedia en artículos:
Sube el archivo multimedia a la
.document360/assetscarpeta.Utiliza la siguiente sintaxis para insertar el archivo multimedia en tu artículo:
Por ejemplo, si tu archivo multimedia tiene un nombre
test.png, usa:
Preguntas más frecuentes
¿Pueden las cuentas de equipo editar o publicar los artículos creados en la categoría de GitHub?
Las cuentas de equipo no pueden editar ni publicar los artículos creados en la categoría de GitHub. Si hay que hacer algún cambio, edita el repositorio fuente en GitHub y los cambios se sincronizarán con el artículo Document360 .
¿Cómo funciona la importación y exportación?
La integración soporta una sincronización unidireccional, desde GitHub hasta Document360. Una vez conectado, la estructura de tu repositorio de GitHub se replica tal y como está en Document360. No se permite exportar contenido de vuelta desde Document360 a GitHub.
Cuando enviamos un commit en GitHub, ¿eso automáticamente se envía una compilación en Document360?
Sí. Cuando comprometes los cambios en tu rama de GitHub vinculada, las actualizaciones se sincronizan y publican automáticamente en Document360.
¿Podemos previsualizar o editar artículos de GitHub en Document360?
No. Los artículos sincronizados con GitHub son de solo lectura dentro de Document360. No puedes editar ni previsualizar versiones no publicadas dentro de Document360. Los artículos sincronizados ya estarán publicados y solo podrán editarse en GitHub.
¿Necesito activar la sincronización manualmente?
No. Una vez configurada la conexión con GitHub, Document360 automáticamente extrae y publica actualizaciones cada vez que se hacen commits.
¿Hay borradores o historiales de revisiones para los artículos sincronizados?
No, el historial de revisiones y el seguimiento de cambios no están disponibles para los artículos sincronizados con GitHub en Document360.
¿Puedo crear nuevas páginas en Document360 para proyectos de GitHub?
Solo puedes crear nuevas páginas en GitHub. La estructura de carpetas y artículos en GitHub se refleja exactamente en Document360. La creación de nuevos artículos no está permitida en Document360 para categorías sincronizadas con GitHub.