Skip to content

Commit

Permalink
Merge pull request #997 from ragged993/patch-1
Browse files Browse the repository at this point in the history
Update how-to-write-quick-edits.md
  • Loading branch information
carlyrevier authored May 8, 2024
2 parents 7cac568 + 117d9fd commit 1b2252c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Contribute/content/how-to-write-quick-edits.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,29 @@ We use PRs for all changes, even for contributors who have write access. Most re

## Edit a document in the browser

1. Navigate to the documentation you wish to edit. _Some_ docs pages allow you to edit content directly in the browser. If so, you'll see an **Edit** pencil icon like the one shown below. Choosing the **Edit** pencil icon takes you to the source file on GitHub.
1. Navigate to the documentation you want to edit. _Some_ docs pages allow you to edit content directly in the browser. If so, you'll see an **Edit** pencil icon like the one shown below. Choosing the **Edit** pencil icon takes you to the source file on GitHub.

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

If the **Edit** button isn't present, it means the content isn't open to public contributions. Some pages are generated (for example, from inline documentation in code) and must be edited in the project they belong to.

1. Select the pencil icon at the top of the GitHub file page. If the pencil icon is grayed out or doesn't display, you need to log in to your GitHub account.
1. Select the pencil icon at the top of the GitHub file page. If the 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.":::

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 in the toolbar to check the formatting of your changes.
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**:

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

1. Now that you've proposed and committed your changes, you need to ask the owners of the repository to "pull" your changes into their repository. This is done using a [pull request](https://docs.github.com/articles/using-pull-requests)(PR). When you select **Propose changes**, you'll see a page like this:
1. Now that you've proposed and committed your changes, you need to ask the owners of the repository to "pull" your changes into their repository. This is done using a [pull request](https://docs.github.com/articles/using-pull-requests) (PR). When you select **Propose changes**, you'll see a page like this:

:::image type="content" source="media/how-to-write-quick-edits/create-pull-request.png" alt-text="Screenshot of the comparing changes screen.":::

Expand Down

0 comments on commit 1b2252c

Please sign in to comment.