Colaborar en el editor web

Colabora en la documentación del editor web con branches, pull requests, despliegues de vista previa, enlaces para compartir y edición en tiempo real.

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 básicos de Git para el editor web.

​

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.

​

Flujo de trabajo recomendado

Las solicitudes de extracción te permiten proponer cambios y colaborar con tu equipo antes de fusionarlos con tu documentación en producción. Este flujo de trabajo garantiza que tu equipo revise los cambios antes de publicarlos y mantiene un historial claro de actualizaciones.

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. Usa las implementaciones de vista previa para recopilar comentarios sobre tus cambios.

Cada vez que guardas cambios en una branch, la implementación de vista previa se actualiza automáticamente.

​

Acceder a las implementaciones de vista previa

1. Haz clic en Publish en la barra de herramientas del editor.
2. Haz clic en la URL de vista previa para abrir la implementación de vista previa en una pestaña nueva. El formato de la URL es organization-branch-name.mintlify.app.

​

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.

​

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.

​

Compartir enlaces del editor

Comparte un enlace directo a una página específica del editor con tu equipo. Usa enlaces del editor para colaborar en las actualizaciones y realizar cambios en las páginas.

Cuando abres una página, el editor guarda la ruta de la página en la URL. Copia la URL de la barra de direcciones de tu navegador para compartirla con los miembros del equipo que tienen acceso al editor.

El formato de la URL es: https://dashboard.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath}

Por ejemplo, https://dashboard.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx abre quickstart.mdx en la branch main.

Cualquier persona con acceso a tu organización de Mintlify puede usar el enlace para abrir el archivo directamente en el editor.

Cuando compartas una página, indica en qué branch estás trabajando para que puedan confirmar que están viendo la versión correcta.