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

  • 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. Создание запроса на вытягивание

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

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

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

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

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

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

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

  5. Выберите "Создать запрос на вытягивание".

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

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

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

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

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