Travailler sur GitHub Docs dans un codespace

Vous pouvez utiliser GitHub Codespaces pour travailler sur la documentation pour GitHub Docs.

Dans cet article

À propos de GitHub Codespaces

GitHub Codespaces vous permet de travailler dans un environnement de développement hébergé à distance depuis votre machine. Vous pouvez commencer rapidement, sans avoir à configurer l’environnement de travail ou à télécharger des fichiers sur votre ordinateur local.

Pour plus d’informations, consultez « Vue d’ensemble de GitHub Codespaces ».

Travailler sur la documentation dans un codespace

Les étapes suivantes supposent que GitHub Codespaces est configuré pour modifier des fichiers en utilisant Visual Studio Code pour le web. Les étapes sont très similaires si vous avez défini un éditeur différent. Pour plus d’informations, consultez « Définition de votre éditeur par défaut pour GitHub Codespaces ».

  1. Accédez au dépôt open source pour GitHub Docs, github/docs.

  2. Si vous êtes contributeur open source, créez une duplication du dépôt, puis suivez le reste des étapes de cette procédure à partir de votre duplication. Pour plus d’informations, consultez « Dupliquer (fork) un référentiel ».

  3. Créez une branche sur laquelle vous allez travailler. Pour plus d’informations, consultez « Création et suppression de branches dans votre référentiel ».

  4. Dans la page principale du dépôt, cliquez sur Code, puis sur Créer un codespace sur NOM-BRANCHE.

    La page « Configuration de votre codespace » s’affiche. Après un court laps de temps, la version basée sur le navigateur de Visual Studio Code s’affiche.

  5. Utilisez l’Explorateur pour accéder au fichier Markdown que vous voulez modifier. Si le fichier est un article, il va se trouver dans le répertoire content. Si le fichier est du contenu réutilisable, il va se trouver dans le répertoire data.

    Dans la plupart des cas, le chemin d’un article dans le répertoire content correspond au chemin de l’URL, sans l’extension de fichier .md. Par exemple, la source de l’article https://docs.github.com/en/codespaces/getting-started/quickstart est le fichier Markdown content/codespaces/getting-started/quickstart.md.

  6. Modifiez le fichier Markdown en fonction des besoins.

  7. Enregistrez vos modifications.

  8. Commitez et envoyez vos modifications, en utilisant la vue Contrôle de code source ou en utilisant des commandes Git à partir du terminal. Pour plus d’informations, consultez « À propos de Git ».

Création d’une demande de tirage

  1. Accédez à l’onglet « Demandes de tirage » du github/docs dépôt à l’adresse github.com/github/docs/pulls.

  2. Cliquez sur Nouvelle demande de tirage.

  3. Si vous êtes contributeur open source, cliquez sur Comparer entre les duplications, puis choisissez le dépôt dupliqué que vous avez créé ainsi que votre branche de travail.

    Sinon, remplacez la branche « à comparer » par votre branche de travail.

  4. Vérifiez que les modifications affichées incluent toutes les modifications que vous avez apportées dans le codespace. Si ce n’est pas le cas, cela peut indiquer qu’il y a des modifications que vous n’avez pas envoyées depuis le codespace vers GitHub.

  5. Cliquez sur Create pull request (Créer une demande de tirage).

  6. Entrez les détails de votre demande de tirage, puis cliquez sur Créer une demande de tirage.

    Votre demande de tirage sera révisée par un membre de l’équipe GitHub Docs.