Работа с документами GitHub в пространстве кода

Для работы с документацией для GitHub Docsможно использовать GitHub Codespaces.

В этой статье

О GitHub Codespaces

GitHub Codespaces позволяет работать в среде разработки, размещенной удаленно с компьютера. Вы можете быстро приступить к работе без необходимости настраивать рабочую среду или скачивать файлы на локальный компьютер.

Дополнительные сведения см. в разделе Обзор GitHub Codespaces.

Работа с документацией в пространстве кода

В следующих шагах предполагается, что у вас есть GitHub Codespaces для редактирования файлов с помощью Visual Studio Code для Интернета. Действия очень похожи, если вы установили другой редактор. Дополнительные сведения см. в разделе Настройка редактора по умолчанию для GitHub Codespaces.

  1. Перейдите в репозиторий открытый код для GitHub Docs, github/docs.

  2. Если вы являетесь открытый код участник, создайте вилку репозитория, а затем выполните остальные действия, описанные в этой процедуре из вилки. Дополнительные сведения см. в разделе Вилка репозитория.

  3. Создайте ветвь для работы. Дополнительные сведения см. в разделе Создание и удаление ветвей в репозитории.

  4. На главной странице репозитория щелкните Code, а затем нажмите кнопку "Создать пространство кода в BRANCH-NAME".

    Отображается страница "Настройка пространства кода". Через некоторое время отображается версия данных на основе браузера Visual Studio Code .

  5. Используйте Обозреватель, чтобы перейти к файлу Markdown, который требуется изменить. Если файл является статьей, он будет расположен в каталоге content . Если файл является повторно используемым содержимым, он будет расположен в каталоге data .

    В большинстве случаев путь к статье в content каталоге соответствует пути в URL-адресе, минус .md расширение файла. Например, источником для статьи https://docs.github.com/en/codespaces/getting-started/quickstart является файл content/codespaces/getting-started/quickstart.mdmarkdown.

  6. Измените файл markdown по мере необходимости.

  7. Сохранение изменений.

  8. Зафиксируйте и отправьте изменения с помощью представления системы управления версиями или с помощью команд Git из терминала. Дополнительные сведения см. в разделе Сведения о GIT.

Создание запроса на включение изменений

  1. Перейдите на вкладку "Запросы на вытягивание" репозитория github/docs в github.com/github/docs/pulls.

  2. Нажмите кнопку "Создать запрос на вытягивание".

  3. Если вы являетесь открытый код участник, щелкните сравнить между вилками, а затем выберите созданный вами вилку репозиторий и рабочую ветвь.

    В противном случае измените ветвь "compare" на рабочую ветвь.

  4. Убедитесь, что отображаемые изменения включают все изменения, внесенные в пространство кода. Если они нет, это может указывать на наличие изменений, которые не были отправлены из пространства кода на GitHub.

  5. Нажмите кнопку "Создать запрос на вытягивание".

  6. Введите сведения о запросе на вытягивание и нажмите кнопку "Создать запрос на вытягивание".

    Запрос на вытягивание будет проверен членом команды GitHub Docs.