GitHub

Con la integración andGitHub, su equipo puede vincular sin problemas los artículos de la Document360 base de conocimientos a GitHub los problemas, lo que permite una mejor colaboración entre desarrolladores y escritores 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 sin cambiar entre las plataformas.

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 GitHub extensión en la Repositorios de código sección.

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

   

   Se abrirá un nuevo panel Instalar.

4. Seleccione una de las dos opciones en función de sus necesidades:

   • Todos los repositorios: elija sincronizar todos los repositorios.

   • Seleccionar repositorios solo - elige sincronizar repositorios específicos según los requisitos de tu proyecto.

5. Haga clic en Instalar.

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

6. Ingrese sus GitHub credenciales e inicie sesión. Serás redirigido a la Document360 Knowledge base portalcarpeta . Aparecerá el Crear nueva categoría módulo.

7. Seleccione GitHub () como tipo de categoría. Seleccione el repositorio de su archivo GitHub.

Aparecerá un cuadro de diálogo de confirmación que dice "Su GitHub se ha iniciado correctamente".

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

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

    

   ---

   Configuración de un repositorio de Git

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

   Asegúrese de que el repositorio de Git esté configurado correctamente para permitir la obtención 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 pueda organizar subcarpetas y artículos de Markdown.

   • Este nombre de carpeta debe permanecer sin cambios.

     Almacenamiento de archivos multimedia:

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

   • Este nombre de carpeta debe permanecer sin cambios.

     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 llama test.png, use:

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

Configuración de la 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 GitHub con Document360 sin problemas.