Conceptos básicos de Git para el editor

Comprende los conceptos de control de versiones de Git que hay detrás del editor de Mintlify, incluyendo branches, commits, pull requests y flujos de trabajo de fusión.

Git te permite controlar y hacer seguimiento de los cambios en los archivos. Git es el sistema de control de versiones preferido para flujos de trabajo de documentación como código, donde gestionas la documentación de la misma manera que cualquier otro repositorio de código.

El editor web se encarga de las operaciones de Git por ti. Comprender algunos conceptos clave te ayuda a sacar el máximo provecho del editor y a colaborar de manera efectiva con tu equipo.

Lo que Git hace para tu documentación

Git registra cada cambio que se hace en tu documentación. Anota qué cambió, quién lo cambió, cuándo lo cambió y por qué. Esto significa que puedes:

• Ver el historial completo de cualquier página.
• Deshacer cambios revirtiendo a una versión anterior.
• Trabajar en actualizaciones sin afectar tu sitio en producción.
• Revisar los cambios antes de que se publiquen.

Tu repositorio de documentación es la colección de archivos —y su historial— que constituyen tu sitio de documentación. El editor web se conecta a este repositorio para sincronizar y publicar tu contenido.

Conceptos clave

Estos son los conceptos de Git que encontrarás con mayor frecuencia al usar el editor web.

Confirmación

Una instantánea guardada de tus cambios en un momento específico. Cada confirmación incluye un mensaje que describe qué cambió y crea un registro permanente en el historial de tu proyecto.

Cuando publicas cambios, el editor web crea una confirmación en tu repositorio de Git.

Branch

Una línea de trabajo independiente en tu repositorio. A veces se llama una feature branch.

Tu sitio de documentación en producción se construye desde una rama de implementación, normalmente llamada main. Otras ramas te permiten trabajar en cambios de forma independiente sin afectar tu sitio en producción. Nada en una rama se publica hasta que la fusionas con tu rama de implementación mediante una solicitud de extracción.

Cambia entre ramas usando el menú desplegable de ramas en la barra de herramientas del editor. Si tienes cambios sin publicar, el editor te permite llevarlos a la nueva rama o dejarlos en tu rama actual.

Rama de implementación

La rama que construye tu sitio de documentación en producción, normalmente llamada main. Los cambios que se fusionan en esta rama se implementan automáticamente en tu sitio.

Solicitud de extracción

Una propuesta para unir cambios de una rama a otra. Las solicitudes de extracción permiten que tu equipo revise y discuta los cambios antes de que se publiquen.

Cuando publicas cambios en una feature branch (o cuando tu repositorio exige solicitudes de extracción), el editor web crea una solicitud de extracción. Tu equipo revisa y une la solicitud de extracción en tu proveedor de Git (GitHub o GitLab).

Merge

Combinar cambios de una rama en otra. Después de que tu equipo revisa y aprueba una solicitud de extracción, fusionar la rama incorpora tus cambios en la rama de implementación y los publica.

Conflicto

Ocurre cuando dos ramas tienen cambios incompatibles en los mismos archivos. El editor te ayuda a resolver los conflictos cuando se producen.

Diff

Una comparación que muestra las diferencias entre dos versiones de un archivo. El editor muestra un diff visual de tus cambios pendientes antes de publicar, para que puedas revisar exactamente qué se va a confirmar.

Cómo se relaciona el editor con Git

Cada acción de publicación en el editor web corresponde a una operación de Git.

Tu acción en el editor	Operación de Git en segundo plano
Editar una página	Los cambios se guardan automáticamente en los servidores de Mintlify (aún no hay commit de Git)
Cambiar de branch	Hacer checkout de la branch seleccionada
Publicar en tu rama de implementación	Confirmar los cambios en tu repositorio y desencadenar una implementación
Publicar en una feature branch	Confirmar los cambios y crear una solicitud de extracción
Push externo o actualización desde la CLI	Los cambios entrantes se sincronizan automáticamente en el editor