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.

Sign up for GitHub

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

Test Contributor... #1060

Closed
wants to merge 1 commit into from
Closed

Test Contributor... #1060

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions Contribute/content/how-to-write-quick-edits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Edit Microsoft Learn documentation in the browser
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.
description: Learn how to edit a Microsoft Learn article in the browser using GitHub's user interface without having to download or install tools.
author: carlyrevier
ms.author: cahublou
ms.date: 02/01/2024
Expand All @@ -16,9 +16,9 @@ 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. We appreciate your help in identifying and fixing these issues!
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.
We use PRs for all changes, even for contributors who have write access. Most repositories have protected default branches, which means all updates must be submitted as pull requests (PRs).

## Prerequisite

Expand All @@ -34,17 +34,17 @@ We use PRs for all changes, even for contributors who have write access. Most re

1. Select the **Edit** pencil icon at the top of the GitHub file page. If the **Edit** pencil icon is unavailable (appears dimmed) or doesn't display, you need to log in to your GitHub account.

:::image type="content" source="media/how-to-write-quick-edits/edit-icon.png" alt-text="Screenshot of the Azure article within GitHub,showing the **Edit** pencil icon.":::
:::image type="content" source="media/how-to-write-quick-edits/edit-icon.png" alt-text="Screenshot of the Azure article within GitHub, showing the **Edit** pencil icon.":::

At the top of the article is the article's metadata. Metadata is applied to articles for reporting, discoverability via search, and driving aspects of the site experience. If you're making minor updates to a published article, you probably won't need to change the metadata.
At the top of the article is the article's metadata. Metadata is applied to articles for reporting, discoverability via search and driving aspects of the site experience. If you're making minor updates to a published article, you probably won't need to change the metadata.

1. If it's your first time working in this repository, you'll be prompted to fork the repo before you propose changes. Select **Fork this repository** to continue.

1. Edit the file in the web editor. Choose the **Preview** tab on the toolbar to check the formatting of your changes.

1. When you're finished editing, select the **Commit changes** or **Propose changes** button, usually at the top-right of the screen.

1. Enter a commit message. The commit message becomes the title of your PR and should be a brief summary of your changes (for example, "Fix spelling and grammar errors"). Optionally, add an **Extended description** to give more details about your changes. Select **Propose changes**:
1. Enter a commit message. The commit message becomes the title of your PR and should be a summary of your changes (for example, "Fix spelling and grammar errors"). Optionally, add an **Extended description** to give more details about your changes. Select **Propose changes**:

:::image type="content" source="media/how-to-write-quick-edits/commit-changes.png" alt-text="Screenshot of the propose changes pop-up.":::

Expand Down