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

  • Статья

Совет

Самоуправляемый пошаговый путь обучения доступен для этого раздела.

Несколько наборов документации Майкрософт открытый код и размещены на сайте GitHub. Хотя не все наборы документации полностью открытый код, многие имеют общедоступные репозитории, где можно предложить изменения с помощью запросов на вытягивание (PR). Этот подход с открытым кодом упрощает и улучшает взаимодействие между инженерами продуктов, командами содержимого и клиентами.

Быстрые изменения упрощают процесс для создания отчетов и устранения небольших ошибок и упущений в документации. Несмотря на все прилагаемые усилия, в публикуемых документах, к сожалению, встречаются небольшие грамматические ошибки и опечатки. Мы ценим вашу помощь в выявлении и устранении этих проблем!

Запросы на вытягивание используются для всех изменений, даже если участники имеют доступ на запись. Большинство репозиториев защищают ветвь по умолчанию, поэтому обновления должны быть отправлены как PR.

Необходимые условия

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

  1. Перейдите к документации, которую вы хотите изменить. Содержимое на некоторых страницах документов можно редактировать прямо в браузере. В этом случае вы увидите значок редактирования карандаша, как показано ниже. При выборе значка "Изменить карандаш" вы перейдете в исходный файл на GitHub.

    Screenshot of an Azure documentation article showing the edit pencil icon.

    Если вы не видите кнопку Изменить, значит, содержимое не открыто для общедоступного редактирования. Некоторые страницы (например, из встроенной документации в коде) должны создаваться и редактироваться в проекте, к которому они относятся.

  2. Щелкните значок карандаша в верхней части страницы файла GitHub. Если значок карандаша не отображается или не отображается, необходимо войти в учетную запись GitHub.

    Screenshot of the Azure article within GitHub,showing the edit pencil icon.

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

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

  4. Измените файл в веб-редакторе. Перейдите на вкладку "Предварительный просмотр" на панели инструментов, чтобы проверка форматирование изменений.

  5. После завершения редактирования нажмите кнопку "Зафиксировать изменения" или "Предложить изменения", как правило, в правом верхнем углу экрана.

  6. Введите сообщение фиксации. Сообщение фиксации становится заголовком вашего PR и должно быть краткой сводкой изменений (например, "Исправление ошибок орфографии и грамматики"). При необходимости добавьте расширенное описание , чтобы получить дополнительные сведения об изменениях. Выберите " Предложить изменения":

    Screenshot of the propose changes pop-up.

  7. После предложения и фиксации изменений необходимо попросить владельцев репозитория вытянуть эти изменения в репозиторий. Это делается с помощью запроса на вытягивание (PR). При выборе предложения изменений вы увидите такую страницу:

    Screenshot of the comparing changes screen.

    Ваш PR предлагает изменения из вилки и ветви (представленные двумя элементами в правой части стрелки) в основную вилку и main ветвь репозитория документации (представленные двумя элементами в левой части стрелки).

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

  8. На странице "Открытие запроса на вытягивание" просмотрите запрос на вытягивание. При необходимости можно изменить поля заголовка или описания. Когда вы будете готовы, нажмите кнопку "Создать запрос на вытягивание". Это действие открывает ваш PR и оповещает владельца статьи, который вы предложили изменить.

  9. Вот и все! Участники команды по созданию содержимого проверят ваш запрос на вытягивание и выполнят слияние, когда он будет одобрен. Вы можете получить обратную связь с запросом изменений. Дополнительные сведения об обработке запроса на вытягивание см. в разделе "Обработка запроса на вытягивание".

Ограничения

  • Большинство локализованных (т. е. переведенных) содержимого не обеспечивает возможность редактирования с помощью GitHub. Однако вы можете предоставить отзыв о качестве перевода, нажав кнопку "Обратная связь" (отпечаток) в верхней части страницы, а затем выбрав причину качества перевода. Вы также можете оставить более конкретные отзывы о локализованном содержимом с помощью формы "Предоставить отзыв".
  • Возможности редактирования в браузере лучше всего подходят для незначительных и редких изменений. Если вы вносите большие вклады или используете расширенные функции Git (например, управление филиалами или расширенное разрешение конфликт слияния), рекомендуется вставить репозиторий и работать локально.