Skip to main content

Trabajo en GitHub Docs en un codespace

Puedes usar GitHub Codespaces a fin de trabajar en documentación para GitHub Docs.

Acerca de GitHub Codespaces

GitHub Codespaces permite trabajar en un entorno de desarrollo hospedado de forma remota desde la máquina. Puedes empezar a trabajar rápidamente, sin necesidad de configurar el entorno de trabajo ni de descargar archivos en el equipo local.

Para más información, consulta Resumen de GitHub Codespaces.

Trabajo en la documentación en un codespace

En los pasos siguientes se supone que tienes GitHub Codespaces configurado para editar archivos mediante Visual Studio Code para la Web. Los pasos son muy similares si has establecido un editor diferente. Para más información, consulta Configuración del editor predeterminado para GitHub Codespaces.

  1. Desplázate hasta el repositorio de código abierto para GitHub Docs, github/docs.

  2. Si eres colaborador de código abierto, crea una bifurcación del repositorio y, a continuación, sigue el resto de los pasos de este procedimiento desde la bifurcación. Para más información, consulta Bifurcar un repositorio.

  3. Crea una rama en la que trabajar. Para más información, consulta Crear y eliminar ramas en tu repositorio.

  4. En la página principal del repositorio, haz clic en Código y, a continuación, haz clic en Crear codespace en BRANCH-NAME.

    Se muestra la página "Configurar el codespace". Poco después, se muestra la versión basada en explorador de Visual Studio Code.

  5. Usa el Explorador para ir al archivo Markdown que deseas editar. Si el archivo es un artículo, se ubicará en el directorio content. Si el archivo es contenido reutilizable, se ubicará en el directorio data.

    En la mayoría de los casos, la ruta de acceso a un artículo del directorio content coincide con la ruta de acceso de la dirección URL, menos la extensión de archivo .md. Por ejemplo, el origen del artículo https://docs.github.com/en/codespaces/getting-started/quickstart es el archivo Markdown content/codespaces/getting-started/quickstart.md.

  6. Edita el archivo Markdown según sea necesario.

  7. Guarde los cambios.

  8. Confirma y envía los cambios mediante el uso de la vista Control de código fuente o de comandos de Git desde el terminal. Para más información, consulta Acerca de Git.

Crear una solicitud de incorporación de cambios

  1. Ve a la pestaña "Solicitudes de incorporación de cambios" del repositorio github/docs en github.com/github/docs/pulls.

  2. Haz clic en Nueva solicitud de incorporación de cambios.

  3. Si eres colaborador de código abierto, haz clic en comparar entre bifurcaciones y, a continuación, elige el repositorio bifurcado que creaste y la rama de trabajo.

    De lo contrario, cambia la rama de "comparación" por la rama de trabajo.

  4. Comprueba que entre los cambios mostrados se incluyen todos los cambios realizados en el codespace. Si no es así, esto puede indicar que hay cambios que no has enviado desde el codespace a GitHub.

  5. Haga clic en Create pull request (Crear solicitud de incorporación de cambios).

  6. Escribe los detalles de la PR y haz clic en Crear solicitud de incorporación de cambios.

    Un miembro del equipo de GitHub Docs revisará la PR.