Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create feedback article #961

Merged
merged 8 commits into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Contribute/content/TOC.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
href: hacktoberfest.md
- name: Review pull requests
href: how-to-review-pull-request.md
- name: Provide feedback on content
href: provide-feedback.md
- name: Create GitHub issues
href: how-to-create-github-issues.md
- name: Create and manage Collections
Expand Down
1 change: 1 addition & 0 deletions Contribute/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Once you've set up your accounts, select a contribution option from the table to
|---------|---------|
|[Edit documentation](how-to-write-overview.md) | GitHub |
|[Review pull requests](how-to-review-pull-request.md) | GitHub |
|[Provide feedback on content](provide-feedback.md) | None for standard experience; GitHub for open-source experience |
|[Create GitHub issues](how-to-create-github-issues.md) | GitHub |
|[Answer questions on Microsoft Q&A](qna-overview.md) | Microsoft |
|[Create a Collection](collections.md) | Microsoft |
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
102 changes: 102 additions & 0 deletions Contribute/content/provide-feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
title: Provide feedback for Microsoft Learn content
description: Learn how to provide feedback to Microsoft Learn content teams using the new feedback experience for documentation and training content.
author: carlyrevier
ms.author: cahublou
ms.topic: contributor-guide
ms.prod: non-product-specific
ms.custom: external-contributor-guide
ms.date: 02/22/2024
---

# Provide feedback for Microsoft Learn content

This article explains how to provide feedback for Microsoft Learn content using the new feedback experience. This unified feedback experience is now standard across all products that publish documentation or training content on Microsoft Learn. The improved system:
carlyrevier marked this conversation as resolved.
Show resolved Hide resolved
carlyrevier marked this conversation as resolved.
Show resolved Hide resolved

- Simplifies our procedures to efficiently incorporate your feedback.
carlyrevier marked this conversation as resolved.
Show resolved Hide resolved
- Allows for feedback in languages other than English.
- Enhances the ability of content authors to respond to feedback.
- Supports global accessibility for non-English customers.
- Reduces the burden of providing feedback for the non-developer community.

Depending on the repository, you may see a standard feedback experience and/or an open-source experience.
carlyrevier marked this conversation as resolved.
Show resolved Hide resolved
carlyrevier marked this conversation as resolved.
Show resolved Hide resolved

## Prerequisites

- None, if using the [standard experience](#use-the-standard-experience).
- A GitHub account, if using the [open-source experience](#use-the-open-source-experience).

## Use the standard experience

The majority of content sets use the standard experience, which allows you to provide feedback using a thumbs up/thumbs down control. You don’t need to log in or create an account to use this experience.

While GitHub issues are no longer supported within repositories using the standard experience, you can still contribute to Microsoft Learn documentation by [creating a pull request](how-to-write-quick-edits.md) if you spot an error or wish to add something.

To leave feedback with the standard experience:

1. Navigate to the article you’d like to give feedback on.
1. Find the **Feedback** link and select it.
1. In documentation, the link is at the top of the page and in a larger box at the bottom of the page.

![Screenshot of the feedback link at the top of a documentation page.](media/provide-feedback/feedback-link.png)

1. In training modules, the link is at the top of the module’s landing page and at the bottom of each unit within the module.

![Screenshot of the feedback link at the top of a training module.](media/provide-feedback/feedback-link-training.png)

1. Choose the thumbs up option if you found the page helpful; choose the thumbs down option if it wasn’t.
1. Choose a reason for your feedback. Optionally, use the comment box to provide specific feedback on the content.
carlyrevier marked this conversation as resolved.
Show resolved Hide resolved
carlyrevier marked this conversation as resolved.
Show resolved Hide resolved

![Screenshot of the feedback control.](media/provide-feedback/feedback-box.png)

The feedback control allows you to provide feedback on Microsoft Learn content. Your feedback will be evaluated by Microsoft content writers, not product teams.

If you want to leave feedback for the product itself, select **Provide product feedback** at the bottom of the feedback box. This link will take you to a platform where you can provide feedback on the product, which is reviewed by the respective product teams.

The feedback control also offers an optional link to either the product's community site or the Q&A platform. If you have specific questions and require community assistance, you can use these platforms to get help.

1. Select **Submit**.

The feedback you provide is anonymous, and Microsoft doesn’t collect personal data from your submission. In the new experience, feedback isn’t publicly visible to ensure customer privacy.

## Use the open-source experience

The open-source feedback experience allows open-source communities to use GitHub issues for documentation related to open-source products. When enabled, this hybrid experience includes the standard feedback experience at the top of the page and an option to open a GitHub issue at the bottom of the page:

:::image type="content" source="media/provide-feedback/open-source.png" alt-text="Screenshot of the open-source experience at the bottom of a documentation page.":::

To open a GitHub issue, you must have a GitHub account. For more information, see [Create GitHub issues](how-to-create-github-issues.md).

Currently, the open-source experience is enabled for the following repositories:

- Azure/azure-docs-sdk-dotnet
- Azure/azure-docs-sdk-java
- dotnet/AspNetCore.Docs
- dotnet/docs
- dotnet/docs-aspire
- dotnet/docs-desktop
- dotnet/docs-maui
- dotnet/entityframework.apidocs
- dotnet/entityframework.docs
- dotnet/maui-api-docs
- MicrosoftDocs/azure-docs-powershell
- MicrosoftDocs/azure-docs-sdk-node
- MicrosoftDocs/azure-docs-sdk-python
- MicrosoftDocs/microsoft-365-community
- MicrosoftDocs/PowerShell-Docs
- MicrosoftDocs/PowerShell-Docs-DSC
- MicrosoftDocs/PowerShell-Docs-Modules
- MicrosoftDocs/PowerShell-Docs-PSGet
- MicrosoftDocs/terminal
- MicrosoftDocs/Windows-Dev-Docs
- MicrosoftDocs/WSL
- Mono/SkiaSharp-API-docs
- OfficeDev/office-js-docs-pr
- OfficeDev/office-js-docs-reference
- OfficeDev/office-scripts-docs
- OfficeDev/office-scripts-docs-reference
- Xamarin/essentials

## Related content

- [Edit documentation in the browser](how-to-write-quick-edits.md)