Skip to content

Commit

Permalink
Fix other mentions of issues
Browse files Browse the repository at this point in the history
  • Loading branch information
carlyrevier committed Feb 24, 2024
1 parent 35de0d0 commit 49076b0
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/general-issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Issues submitted here are reviewed by the repo managers of the contributor guide

If you have feedback about a product or product documentation, use one of these outlets instead:

- For Microsoft Learn documentation: Either the feedback link at the top of the article, or the feedback area at the bottom of an article. If there is none, post to our [feedback portal](https://feedbackportal.microsoft.com/feedback/).
- For Microsoft Learn documentation: Use the **Feedback** link at the top of the article. If there is none, post to our [feedback portal](https://feedbackportal.microsoft.com/feedback/).

- For Microsoft Learn training content: The **reporting an issue** feedback link at the bottom of each unit. If there is none, use the **Report feedback** tool at the very bottom of [this article](https://learn.microsoft.com/learn/support/troubleshooting?branch=main#report-feedback).
- For Microsoft Learn training content: Use the **Feedback** link at the top of a module landing page or the **Feedback** link at the bottom of each module unit.

Thank you!
12 changes: 6 additions & 6 deletions Contribute/content/how-to-create-github-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ Our open-source product documentation is a continuous work in progress. Receivin

Of course, if you know how to fix an issue, we invite you to [make the changes yourself](how-to-write-quick-edits.md), instead of opening an issue.

Only open-source products using the open-source feedback experience accept GitHub issues. For more information and a list of participating repositories, see [Use the open-source experience](provide-feedback.md#use-the-open-source-experience). To leave feedback on non-open-source product documentation, see [Provide feedback on Microsoft Learn](provide-feedback.md).
> [!NOTE]
> Only open-source products using the open-source feedback experience accept GitHub issues. For more information and a list of participating repositories, see [Use the open-source experience](provide-feedback.md#use-the-open-source-experience). To leave feedback on non-open-source product documentation, see [Provide feedback on Microsoft Learn](provide-feedback.md).
## Prerequisites

Expand All @@ -26,20 +27,19 @@ Only open-source products using the open-source feedback experience accept GitHu
## Create an issue

1. Navigate to the article you want to comment on.
1. Scroll to the bottom of the article, where you'll see options for submitting feedback.
1. Scroll to the bottom of the article, where you'll see options for submitting feedback. Select **Open a documentation issue** to create a new issue. This feedback is specific to the content and is tracked as an issue in GitHub.

![Screenshot of the bottom of an article, showing the feedback options.](media/how-to-create-github-issues/feedback-links.png)

- Select **Open a documentation issue** to create a new issue in the GitHub repository that stores the content for the article you're viewing. This feedback is specific to the content and is tracked as an issue in GitHub.
- Select **Provide product feedback** to go to a destination (for example, UserVoice, GitHub, an email address) where you can provide feedback on the product itself. This feedback is independent of the content and has no relationship back to the original article.
Optionally, select **Provide product feedback** to go to a destination (for example, a feedback portal, GitHub, an email address) where you can provide feedback on the product itself. This feedback is independent of the content and has no relationship back to the original article.

1. The system opens a new issue for you in the GitHub repository that stores the content for the article you're viewing. Add a title and a description; all other fields should populate for you automatically. When you're done, select **Submit new issue**.

:::image type="content" source="media/how-to-create-github-issues/github-issue.png" alt-text="Screenshot of the new-issue form in GitHub.":::

The more detail you provide, the more helpful the issue. Tell us what information you sought. Tell us the search terms you used. If you can't get started, tell us how you want to start exploring unfamiliar technology. You can also add screenshots or files to help us understand your issue.
The more detail you provide, the more helpful the issue is. Tell us what information you sough or the search terms you used to get to this article. If you can't get started, tell us how you want to start exploring unfamiliar technology. You can also add screenshots or files to help us understand your issue.

That's it! Your issue is now added to the Issues queue. Issues start the conversation about what's needed. The content team will respond to these issues with ideas for what we can add and ask for your opinions. When we create a draft, we'll ask you to [review the PR](#review-open-prs).
That's it! Your issue is now added to the Issues queue. Issues start the conversation about what's needed. The content team will respond to these issues with ideas for what we can add and ask for your opinions. When we create a draft, we'll ask you to [review the PR](how-to-review-pull-request.md).

## Comment on an issue

Expand Down
2 changes: 1 addition & 1 deletion Contribute/content/how-to-write-quick-edits.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ms.custom: external-contributor-guide
Several of Microsoft's documentation sets are open source and hosted on GitHub. While not all documentation sets are completely open source, many have public-facing repositories where you can suggest changes via pull requests (PRs). This open-source approach streamlines and improves communication between product engineers, content teams, and customers.

Quick edits facilitate the process to report and fix small errors and omissions in documentation. Despite all efforts, small grammar and spelling errors _do_ make their way into our published documents. While you can create issues to report mistakes, it's faster and easier to create a PR to fix the issue when the option is available.
Quick edits facilitate the process to report and fix small errors and omissions in documentation. Despite all efforts, small grammar and spelling errors _do_ make their way into our published documents. We appreciate your help in identifying and fixing these issues!

We use PRs for all changes, even for contributors who have write access. Most repositories protect the default branch, so updates must be submitted as PRs.

Expand Down
2 changes: 1 addition & 1 deletion Contribute/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,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 |
|[Create GitHub issues for open-source product documentation](how-to-create-github-issues.md) | GitHub |
|[Answer questions on Microsoft Q&A](qna-overview.md) | Microsoft |
|[Create a Collection](collections.md) | Microsoft |
|[Participate in the Microsoft Learn Tech Community](https://techcommunity.microsoft.com/t5/microsoft-learn/ct-p/MicrosoftLearn) | Microsoft |
Expand Down
4 changes: 2 additions & 2 deletions Contribute/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,9 @@ sections:
title: Frequently asked questions
questions:
- question: How do I become a Microsoft Learn contributor?
answer: There's more than one way to become a contributor! While editing documentation is the most popular method, you can also answer questions in Microsoft Q&A, create a collection of content for others to consume, or file a GitHub issue if you spot problems in our content but don't have the tools to fix them yourself.
answer: There's more than one way to become a contributor! While editing documentation is the most popular method, you can also answer questions in Microsoft Q&A, leave feedback on documentation and training content, create a collection of content for others to consume, or file a GitHub issue if you spot problems in open-source product documentation but don't have the tools to fix them yourself.
- question: What accounts do contributors need?
answer: We recommend having a Microsoft Learn account and a GitHub account. A Microsoft Learn account allows you to contribute to Q&A and create collections, while a GitHub account allows you to edit our open-source documentation or file an issue about documentation.
answer: We recommend having a Microsoft Learn account and a GitHub account. A Microsoft Learn account allows you to contribute to Q&A and create collections, while a GitHub account allows you to edit our documentation or file an issue about open-source product documentation.
- question: How do I start contributing to Microsoft Learn documentation?
answer: Check out our contributor guide! Start with the article on [how to get started](https://learn.microsoft.com/contribute/content/?branch=main#how-do-i-start). You'll find a table that guides you to documentation for each contribution type and lists the account you'll need for each option. The contributor guide is your home base for learning how to get up and running as a Microsoft Learn contributor!
- question: Who contributes to Microsoft Learn?
Expand Down

0 comments on commit 49076b0

Please sign in to comment.