Saltar al contenido principal
Git es un sistema de control de versiones que te permite realizar un seguimiento de los cambios en tu documentación y colaborar con tu equipo. Con Git, para cada archivo de tu proyecto puedes ver qué cambió, cuándo y por qué. Git también facilita volver a versiones anteriores de los archivos cuando lo necesites. El editor web realiza algunas operaciones de Git en segundo plano. Entender estos conceptos te ayudará a trabajar de forma más eficaz con el editor web y a colaborar con miembros del equipo que trabajan en sus entornos de desarrollo locales.

Conceptos básicos de Git

El origen de tu documentación, donde se almacenan todos los archivos y su historial. El Editor web se conecta a tu repositorio para acceder y modificar el contenido.
Una instantánea guardada de tus cambios en un momento específico. Cada commit incluye un mensaje que describe lo que cambió y crea un registro permanente en el historial de tu proyecto.
Una rama apunta a un commit específico en tu repositorio. Tu documentación en producción se genera a partir de una rama de implementación. Puedes tener cualquier número de otras ramas con cambios que aún no se han publicado en tu documentación en producción. Si quieres incorporar los cambios de una rama en tu documentación en producción, puedes fusionarla en tu rama de implementación mediante una pull request.Usa ramas para trabajar en cambios sin afectar tu documentación en producción, experimentar de forma segura con nuevas funciones y obtener revisiones antes de publicar.
La rama principal de tu proyecto a partir de la cual se genera el contenido de tu documentación en producción. Los cambios en esta rama se publican automáticamente en tu sitio de documentación. A menudo se llama main, pero puedes establecer cualquier rama como tu rama de implementación.
Una forma de proponer fusionar los cambios de una rama en tu documentación en producción. Permite revisar y debatir antes de que los cambios se publiquen. Se conoce comúnmente como PR y, en GitLab, como merge request.
Un diff (o diferencia) muestra los cambios entre dos versiones de un archivo. Al revisar pull requests, los diffs resaltan lo que se ha agregado, eliminado o modificado, lo que facilita identificar qué cambió.

Cómo utiliza Git el editor web

El editor web se conecta a tu repositorio de Git a través de la GitHub App o la integración con GitLab y automatiza operaciones comunes de Git. Cuando:
  • Abres un archivo: El editor obtiene la versión más reciente de tu repositorio, garantizando que siempre trabajes con contenido actualizado.
  • Realizas cambios: El editor registra tus cambios como un borrador que puede convertirse en un commit cuando estés listo para guardar tu trabajo.
  • Guardas cambios: El editor crea un commit con tus cambios, preservando tu trabajo en el historial del proyecto.
  • Creas una rama: El editor crea una nueva rama en tu repositorio que puede ser utilizada por cualquier persona con acceso al repositorio para colaborar y revisar los cambios.
  • Publicas en tu rama de despliegue: El editor hace commit y push directamente a tu rama de despliegue, lo que publica tus cambios de inmediato.
  • Publicas en otras ramas: El editor crea una pull request, lo que te permite recibir comentarios de otros antes de fusionar tus cambios en tu rama de despliegue.

Mejores prácticas de Git

Cada equipo desarrollará sus propios flujos de trabajo y preferencias, pero estas son algunas prácticas generales para empezar.
  • Escribe mensajes de commit descriptivos: Sé específico sobre qué cambió y utiliza un lenguaje activo.
  • Usa nombres de rama descriptivos: Los nombres de las ramas deben explicar el trabajo que se está realizando y ser significativos para quien las consulte en tu repositorio.
  • Mantén las ramas enfocadas: Limita los cambios en una rama a una tarea o proyecto específico.
  • Elimina las ramas después de hacer merge: Borra las ramas cuando ya no las necesites para mantener tu repositorio ordenado.