diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 3ba13e0c..00000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1 +0,0 @@ -blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/general-issue-template.md b/.github/ISSUE_TEMPLATE/general-issue-template.md deleted file mode 100644 index ac945964..00000000 --- a/.github/ISSUE_TEMPLATE/general-issue-template.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: General issue template -about: Use this template to report all feedback/issues for the Microsoft Learn contributor guide. -title: '' -labels: '' -assignees: carlyrevier, jehchow - ---- - ---- -**PLEASE READ AND THEN DELETE BEFORE SUBMITTING YOUR ISSUE** - -Welcome to the Microsoft Learn contributor guide feedback form! - -Issues submitted here are reviewed by the repo managers of the contributor guide, **not product teams.** Your issue should pertain to the documentation in this [contributor guide](https://learn.microsoft.com/contribute) only. Requests for updates to products or product documentation will be closed. - -If you have feedback about a product or product documentation, use one of these outlets instead: - -- 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: 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! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 25e00932..a7d3f0bf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,7 @@ Thanks for contributing to the [Microsoft Learn contributor guide](https://learn ## Quality control -- [ ] 1. **Successful build with no warnings**: Review the build status to make sure **all checks are green** (Succeeded). +- [ ] 1. **Successful build with no warnings or errors**: Review the build status to make sure **all checks are green** (Succeeded). - [ ] 2. **#Sign-off**: Once the PR is finalized and ready to be merged, indicate so by typing `#sign-off` in a new comment in the PR. Signing off means the document is ready for review and can be published at any time. @@ -15,5 +15,4 @@ Thanks for contributing to the [Microsoft Learn contributor guide](https://learn ## Need help? -- If you have an open PR, tag the PR reviewers in comment with your question: `@carlyrevier, @jehchow` -- Open an issue in this repo and tag the PR reviewers. +If you have an open PR, tag the PR reviewers in a comment with your question: `@carlyrevier, @jehchow` diff --git a/Contribute/content/docs-authoring/metadata-explorer.md b/Contribute/content/docs-authoring/metadata-explorer.md index bc2b6858..5fd0e3a1 100644 --- a/Contribute/content/docs-authoring/metadata-explorer.md +++ b/Contribute/content/docs-authoring/metadata-explorer.md @@ -15,7 +15,7 @@ feedback_product_url: https://github.com/microsoft/vscode-docs-authoring/issues ## Summary -The Metadata explorer appears automatically in the Explorer side bar of Visual Studio Code when you open a Learn Markdown file. It has two main sections: [required metadata](../metadata.md#required-metadata) and [optional metadata](../metadata.md#optional-metadata). +The Metadata explorer appears automatically in the Explorer sidebar of Visual Studio Code when you open a Learn Markdown file. It has two main sections: [required metadata](../metadata.md#required-metadata) and [optional metadata](../metadata.md#optional-metadata). :::image type="content" source="media/metadata-explorer.PNG" alt-text="Metadata explorer in Visual Studio Code"::: diff --git a/Contribute/content/git-github-fundamentals.md b/Contribute/content/git-github-fundamentals.md index a131a44c..14bb3382 100644 --- a/Contribute/content/git-github-fundamentals.md +++ b/Contribute/content/git-github-fundamentals.md @@ -1,6 +1,6 @@ --- title: Git and GitHub essentials for Microsoft Learn documentation -description: This article defines key terms, provides an overview of Git and GitHub repositories, and explains how content is organized for Microsoft technical documentation. +description: This article defines key terms, provides an overview of Git and GitHub repositories, and explains how content is organized for Microsoft Learn documentation. author: carlyrevier ms.author: cahublou ms.topic: contributor-guide @@ -99,7 +99,7 @@ This term is the name assigned to the connection between your local repository a A *pull request* (PR) is a request for a content owner to pull your changes into the official source. A PR enables GitHub's collaboration model by asking for the changes (also known as *commits*) from your working branch to be pulled and merged into another branch. In most cases, that other branch is the default branch in the main repository. -A PR also serves as a mechanism to provide the contributor with feedback from Microsoft Learn's validation processes and the PR reviewer, to resolve potential issues or questions before the changes are merged into the default branch. +A PR also serves as a mechanism to provide the contributor with feedback from Microsoft Learn's validation processes and the PR reviewer to resolve issues or questions before the changes are merged into the default branch. ## Remote diff --git a/Contribute/content/how-to-write-quick-edits.md b/Contribute/content/how-to-write-quick-edits.md index 4768aff1..ad668b78 100644 --- a/Contribute/content/how-to-write-quick-edits.md +++ b/Contribute/content/how-to-write-quick-edits.md @@ -1,6 +1,6 @@ --- title: Edit Microsoft Learn documentation in the browser -description: Learn how to edit a Microsoft Learn documentation article in the browser using GitHub. +description: Learn how to edit a Microsoft Learn article in the browser using GitHub's user interface and without having to download or install tools. author: carlyrevier ms.author: cahublou ms.date: 02/01/2024