Измените статью документации в браузере

  • 5 мин

Теперь, когда у вас есть обзор общих инструментов и функционирующих частей системы внесения изменений, давайте рассмотрим конкретные шаги, чтобы сделать маленький вклад в документацию Майкрософт. Если вы хотите внести небольшое изменение в статью, сначала убедитесь, что у вас есть соответствующие средства. Затем вы готовы начать редактирование и совместное использование знаний с другими членами сообщества Microsoft Learn.

Шаг 1. Настройка учетной записи GitHub

Так как Microsoft Learn интегрирует рабочие процессы GitHub для обновления содержимого, требуется учетная запись GitHub для участия. Если у вас уже есть учетная запись GitHub, убедитесь, что вы вошли в систему.

Если у вас еще нет учетной записи GitHub, выполните следующие действия, чтобы создать ее:

  1. Перейдите к GitHub.
  2. Выберите Зарегистрироваться.
  3. Следуйте инструкциям по настройке учетной записи.

Шаг 2. Внесение изменений

Помните, что не все содержимое Microsoft Learn хранится в общедоступный репозиторий. Прежде чем вносить какие-либо изменения, сначала проверьте, доступно ли содержимое, в которое вы хотите внести свой вклад. В этом случае вы можете вносить изменения непосредственно в браузере.

  1. Перейдите к статье документации по learn.microsoft.com, которую вы хотите изменить. Проверьте, хранится ли статья в общедоступном репозитории, найдите значок Изменить в форме карандаша в верхней части статьи. Если вы видите значок, он может быть использован для общедоступного вклада!

  2. Нажмите Редактировать (значок с изображением карандаша). При этом вы перейдете в исходный файл в общедоступном репозитории GitHub, в который хранится статья.

    Снимок экрана: статья документации Microsoft Learn с выделенным значком карандаша для редактирования.

  3. Щелкните значок карандаша в верхней части страницы файла GitHub. Этот значок либо помечен как Изменить этот файл в вашем форке этого проекта или Создать форк этого репозитория и изменить файл в зависимости от того, создали ли вы уже форк репозитория, в котором хранится файл.

    Чтобы выбрать этот значок, необходимо войти в учетную запись GitHub. Если вы не вошли, этот параметр недоступен.

    Снимок экрана: исходный файл GitHub для статьи документации. Выделен значок карандаша для редактирования файла.

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

  4. Если вы впервые работаете в этом репозитории, вам будет предложено форкнуть репо перед внесением изменений. Если да, нажмите на Форкнуть этот репозиторий.

  5. В браузере отобразится интерфейс редактирования или область редактирования . Вы можете увидеть статью, написанную с использованием синтаксиса Markdown. Внесите изменения в панели.

    Снимок экрана: браузер с документацией, написанной в синтаксисе Markdown, который можно изменить в области редактирования.

  6. В верхней части области редактирования выберите вкладку "Предварительный просмотр ". Это позволяет проверять изменения, просматривая их в опубликованной форме.

Шаг 3. Создание пулл реквеста

Когда вы закончите вносить и просматривать изменения, пора создать pull request (PR). Помните, что PR — это ваш способ предложить объединить ваши изменения в основную ветвь репозитория, чтобы они стали видимы на Microsoft Learn. Pull Request помогает модели совместной работы GitHub, позволяя запрашивать извлечение и объединение изменений из вашей рабочей ветви в другую ветвь. В большинстве случаев эта другая ветка является основной ветвью в основном репозитории.

  1. Найдите и выберите кнопку "Зафиксировать изменения" или "Предложить изменения", как правило, в верхней части страницы.

  2. Добавьте сообщение о фиксации. Это станет заголовком вашего PR. Сообщение фиксации должно быть кратким описанием ваших изменений. При необходимости добавьте расширенное описание , чтобы получить дополнительные сведения об изменениях.

    Снимок экрана: всплывающее окно с двумя полями для создания сообщения

  3. Выберите " Предложить изменения".

  4. На следующей странице вам предложат подтвердить, в какую ветку вы хотите слить изменения, называемую базовой. Убедитесь, что база имеет значение main.

    Снимок экрана веб-страницы, на которой участники должны проверить целевой репозиторий и ветку, в которые они хотят объединить изменения. Main выбран в качестве базы.

  5. Выберите Создать pull request.

  6. Предварительная версия pr. Внесите изменения в поля заголовка или описания.

  7. Нажмите кнопку "Создать пулл-реквест". Откроется pull request.

Ваш PR создан, но ещё не отправлен. На следующем шаге вы завершите окончательные шаги проверок в вашем PR, чтобы его объединить.

Сценарий: Изменение статьи службы приложений Azure

Помните, что вы инженер по программному обеспечению с особой экспертизой в области Azure App Service. При просмотре статьи документации о Службе приложений, вы замечаете деталь, которую хотите добавить, чтобы помочь другим пользователям использовать службу. Вы решили поделиться своими знаниями, внося свой первый вклад в Microsoft Learn! После входа в учетную запись GitHub вы начнете процесс вклада: