Проверка документации с помощью проблем с GitHub
Одним из наиболее полезных способов участия в Microsoft Learn является предоставление отзывов непосредственно в статье документации. Используя ссылку обратной связи на странице, вы можете указать изменения, предложения, вопросы или другие аналитические сведения при просмотре. Так как большинство содержимого документации Microsoft Learn хранится в репозиториях GitHub, вы можете предоставить отзыв с помощью процесса GitHub, называемого отправкой проблемы GitHub.
Проблема в GitHub — это средство, которое позволяет пользователям технологий, инженерам и другим посетителям Microsoft Learn поделиться и отслеживать отзывы о конкретной статье. Вы заполните форму, чтобы задокументировать отзыв и опубликовать ее в репозитории исходной статьи в GitHub, где автор или владелец будет уведомлен. Любой пользователь, посещающий репозиторий GitHub, может видеть проблемы. Они служат полезным способом сбора и хранения ценных отзывов, таких как сообщения об ошибках, запросах функций или заметках.
Зачем просматривать содержимое в GitHub?
Предоставление отзывов контента на GitHub — это прямой способ внести свой вклад в тему, о которую вы страстно или осведомлены. Это означает, что вы можете добавить свои идеи по мере изучения темы в документации Майкрософт. Внося свои аналитические сведения в пул знаний, помогает улучшить возможности продуктов Майкрософт для миллионов других пользователей. Ваши отзывы перемещают содержимое для других посетителей Microsoft Learn, которые полагаются на продукты Майкрософт и их вспомогательное содержимое.
В большинстве случаев отправка отзывов GitHub позволяет отправлять свои идеи команде, отвечающей за набор содержимого продукта. Этот путь совместной работы между командами содержимого и пользователями продуктов позволяет предоставлять отзывы и обсуждаться непосредственно в GitHub.
Участие в содержимом документации также может предоставлять профессиональные преимущества. GitHub — это хорошо известная платформа, в которой можно внести и отслеживать технические вклады. Каждый раз, когда вы вносите свой вклад в проект на GitHub, он отражается в профиле GitHub. Со временем вы можете создать запись ваших вкладов, чтобы добавить в свой технический портфель.
Как дать отзыв о содержимом
Помните, что многие статьи документации в Microsoft Learn хранятся в репозиториях GitHub. Многие репозитории GitHub имеют включенные проблемы с GitHub. Если этот параметр включен, можно найти вариант отправки отзывов на эту страницу в нижней части статьи на learn.microsoft.com.
Чтобы создать и отправить проблему, вам нужна учетная запись GitHub. Вот как отправить проблему в GitHub из статьи Microsoft Learn:
Войдите в свою учетную запись GitHub.
Перейдите к статье документации Microsoft Learn, в которой вы хотите отправить отзыв.
В нижней части статьи найдите заголовок с меткой "Отзывы". Здесь вы увидите поле с меткой "Эта страница".
- Чтобы отправить отзыв о самой статье, выберите эту страницу. При этом вы перейдете в пустую форму "Проблемы" на сайте GitHub, где можно начать заполнение комментариев. Теперь вы выберете этот параметр.
- Если вы хотите просмотреть другие проблемы GitHub, отправленные в разделе, выберите просмотреть все отзывы на странице. Любой пользователь может прочитать другие проблемы GitHub в общедоступном репозитории, но если у вас есть учетная запись GitHub, вы также можете комментировать проблемы.
- Выбор этого продукта позволяет предоставлять отзывы о самом продукте. Мы не будем подробно идти на этот вариант, чтобы мы могли сосредоточиться на предоставлении отзывов о самой документации.
После выбора этой страницы вам будет предложено войти в учетную запись GitHub, если вы еще не сделали этого. Затем в GitHub появится пустая форма отзывов о проблемах.
Введите заголовок для ваших отзывов, которые кратко суммируют входные данные.
В текстовом поле ниже опишите свой отзыв и укажите необходимый контекст. Используйте панель инструментов для форматирования описания, например добавления цитаты, списка или упоминания.
По завершении нажмите кнопку "Отправить новую проблему".
Отслеживание проблем
Автор статьи или другие владельцы контента будут уведомлены при отправке проблемы. Вы можете отслеживать комментарии по этой проблеме, проверяя уведомления GitHub или возвращаясь в репозиторий и проверяя вкладку "Проблемы ".
Вы также можете просматривать, просматривать и комментировать другие проблемы, отправленные для этого репозитория на вкладке "Проблемы ".
