Поделиться через


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

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

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

Перед началом работы убедитесь, что вы вошли в учетную запись GitHub. Если у вас нет учетной записи GitHub, перейдите к https://github.com/join быстрому и бесплатному процессу регистрации.

Незначительные изменения документации

Незначительные изменения являются быстрыми и простыми. Ниже приведены примеры незначительных изменений:

  • Исправление опечаток
  • Изменение одной статьи
  • Добавление раздела в статью
  • Исправление ошибки
  • Обновление неработает ссылок

Если вы вносите незначительные изменения, все, что вам нужно, это учетная запись GitHub!

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

Основные изменения документации

Основные изменения включают больше времени и усилий. Ниже приведены примеры основных изменений:

  • Сложные изменения, которые займет несколько дней, чтобы завершить
  • Изменения в нескольких статьях, которые вы хотите отправить вместе
  • Создание статьи
  • Частое участие

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

  1. Установите средства Git и Markdown.
  2. Настройте локальный репозиторий Git.
  3. Внесите изменения в документацию.
  4. Создайте PR.

Обзор процесса

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

Схема потока процесса, показывающая базовый рабочий процесс для начала работы с процессом вклада.

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

Изменения в модулях обучения

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