Saltar al contenido principal
Colabora con tu equipo en la documentación mediante flujos de trabajo basados en branches, solicitudes de extracción e implementaciones de vista previa. Si no conoces Git, consulta Conceptos de Git.

Colaboración basada en branches

Utiliza branches para trabajar en paralelo en actualizaciones de la documentación sin afectar tu sitio en producción.

Por qué usar branches

  • Aislar cambios: Trabaja en actualizaciones sin afectar tu documentación en producción.
  • Revisar antes de publicar: Obtén comentarios del equipo antes de publicar los cambios.
  • Trabajo en paralelo: Varios miembros del equipo pueden trabajar en diferentes branches al mismo tiempo.
  1. Crea una branch específica para tu nueva funcionalidad.
  2. Realiza y guarda tus cambios en la branch.
  3. Crea una solicitud de extracción cuando esté lista para revisión.
  4. Atiende los comentarios y actualiza la branch.
  5. Fusiona la solicitud de extracción cuando se haya aprobado.
Este flujo de trabajo garantiza que los cambios se revisen antes de publicarse y mantiene un historial claro de actualizaciones.

Flujo de trabajo con solicitudes de extracción

Las solicitudes de extracción te permiten proponer cambios y colaborar con tu equipo antes de fusionarlos con tu documentación en producción.
1

Crear una solicitud de extracción

Crea una solicitud de extracción desde el editor cuando estés listo para publicar tus cambios. Consulta Publicar cambios en el editor web para obtener más información sobre el uso de solicitudes de extracción.
2

Revisar solicitudes de extracción

Revisa las solicitudes de extracción en tu proveedor de Git como GitHub o GitLab.
3

Responder a los comentarios

Cuando los revisores soliciten cambios, realiza los cambios solicitados y guarda tus cambios. Se actualizarán automáticamente en la solicitud de extracción existente.
4

Fusionar solicitudes de extracción

Fusiona tu solicitud de extracción cuando se hayan abordado todos los cambios solicitados, la solicitud de extracción haya sido aprobada por los revisores obligatorios y se hayan superado todas las comprobaciones automatizadas.

Implementaciones de vista previa

Las implementaciones de vista previa crean URL temporales donde puedes ver tus cambios antes de que se publiquen.
1

Acceder a las implementaciones de vista previa

  • Haz clic en Share en la barra de herramientas del editor.
  • Haz clic en Preview para abrir la implementación de vista previa en una nueva pestaña.
  • La URL de vista previa muestra tu documentación con todos los cambios guardados aplicados.
2

Compartir vistas previas

Comparte la URL de la implementación de vista previa con los miembros del equipo para recopilar comentarios. Las vistas previas se actualizan automáticamente cuando guardas cambios adicionales.
3

Autenticación en vista previa

Las URL de vista previa son de acceso público de forma predeterminada. Habilita la autenticación en vista previa en la página de Add-ons de tu dashboard para restringir el acceso a los miembros autenticados de la organización.