GitHub (en inglés)

Con la integración Document360 y GitHub , su equipo puede vincular sin problemas los artículos de la base de conocimientos con GitHub problemas, lo que permite una mejor colaboración entre los desarrolladores y los redactores técnicos. Puede realizar un seguimiento de las actualizaciones, asociar tareas de documentación con cambios de código y asegurarse de que su base de conocimientos se mantenga sincronizada con su proceso de desarrollo, todo ello sin tener que cambiar de plataforma.

Configuración de GitHub en Document360

Para configurar GitHub en Document360,

1. Vaya a Configuración () en la barra de navegación izquierda del portal de la base de conocimientos.

2. En el panel de navegación izquierdo, vaya a Portal de la base de conocimientos > Extensiones > Colaboración en equipo.

   Puede encontrar la extensión GitHub en la sección Repositorios de código .

3. Haga clic Conectar en el mosaico de la extensión.

   

   Se abrirá un nuevo panel de instalación.

4. Seleccione cualquiera de las dos opciones en función de sus requisitos:

   • Todos los repositorios: elija sincronizar todos los repositorios.

   • Seleccionar solo repositorios: elija sincronizar los específicos en función de los requisitos de su proyecto.

5. Haga clic en Instalar.

   

   Si no ha iniciado sesión en GitHub, será redirigido a la pantalla de inicio de sesión.

   5. Ingrese sus credenciales de GitHube inicie sesión.

   Será redirigido al Document360 Knowledge base portal. Aparecerá el módulo Crear nueva categoría .

   6. Seleccione GitHub () como tipo de categoría.

   7. Seleccione el repositorio de su GitHubconfigurado.
   

   1. Aparecerá una ventana emergente de confirmación que dice 'Tu GitHub se ha iniciado con éxito'.

      La categoría de repositorio, junto con todas las ramas, se crean como artículos en Document360. Cada vez que un usuario GitHub actualiza el repositorio, el contenido se sincroniza con los artículos Document360 asignados.

   2. Puede identificar cada entidad de Document360 en la categoría GitHub mediante un icono de rama ().

       

   ---

   Configuración del repositorio Git

   Para configurar un repositorio Git para el acceso al contenido en Document360,

   1. Asegúrese de que el repositorio de Git esté correctamente configurado para permitir la captura del contenido en el proyecto de Document360. Siga la siguiente estructura:

          Carpeta principal:

   • En GitHub, el repositorio debe incluir una carpeta principal llamada docs donde se pueden organizar las subcarpetas y los artículos de Markdown.

   • El nombre de esta carpeta no debe cambiar.

     
     Almacenamiento de archivos multimedia:

   • Almacene todos los archivos multimedia dentro de la .document360/assets carpeta dentro del docs directorio.

   • El nombre de esta carpeta no debe cambiar.

     Por ejemplo, si se hace referencia a una imagen en un archivo llamado '¿Qué es Document360', debe moverse a la .document360/assets carpeta.

     
     Almacenamiento de artículos:

   • Dentro de la docs carpeta, cree un directorio separado, por ejemplo, articles para almacenar sus artículos.

   • Los artículos deben estar en formato Markdown (.md).

     Inserción de archivos multimedia en artículos:

   • Cargue el archivo multimedia en la .document360/assets carpeta.

   • Utilice la siguiente sintaxis para insertar el archivo multimedia en el artículo:

     ![image description](/docs/.document360/assets/mediafilename.extension)

   • Por ejemplo, si el archivo multimedia se denomina test.png, utilice:

     ![test image](/docs/.document360/assets/test.png)

Configuración de integración de GitHub con Document360

A continuación se muestra una guía de vídeo paso a paso sobre cómo configurar e integrar sin problemas GitHub con Document360.