diff --git a/README.md b/README.md index 6bc1c67481..799d11a6c6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ --- -ms.date: 9/15/2023 +ms.date: 05/16/2025 --- # Overview @@ -23,26 +23,30 @@ Contributors who make infrequent or small updates can edit the file directly on 2. On learn.microsoft.com, find the article that you want to update. 3. Above the title of the article, select ![Edit this document icon.](images/m365-cc-sc-edit-icon.png) **Edit this document**. - ![Edit this document button on a learn.microsoft.com article.](images/quick-update-edit-button-on-learn-page.png) + ![Screenshot of how to select the Edit this document button on a learn.microsoft.com article.](images/quick-update-edit-button-on-learn-page.png) -4. The corresponding article file opens on GitHub. Select ![Edit this file icon.](images/m365-cc-sc-edit-icon.png) **Edit this file**. +4. The corresponding article file opens on GitHub. Select ![Edit icon.](images/quick-update-github-edit-icon.png) **Edit**. - ![Edit this document button on a GitHub article file.](images/quick-update-edit-button-on-github-page.png) + ![Screenshot of how to select the Edit button on a GitHub article file.](images/quick-update-edit-button-on-github-page.png) -5. The article file opens in a line-numbered editor page where you can make updates. +5. If a **You need to fork this repository to propose changes** page opens, select **Fork this repository**. + + ![Screenshot of how to select Fork this repository on the You need to fork this repository to propose changes page.](images/quick-update-fork-this-repository-page.png) + +6. The article file opens in a line-numbered editor page where you can make updates. Articles on learn.microsoft.com are formatted using the Markdown language. For help on using Markdown, see [Mastering Markdown](https://guides.github.com/features/mastering-markdown/). > [!TIP] - > Cmdlet reference articles follow a very strict schema with limited formatting options, because the articles are also converted and used for help at the command line (`Get-Help Cmdlet reference articles follow a very strict schema with limited formatting options, because the articles are also converted and used for help at the command line (`Get-Help `). Use existing content as a guide. For more information, see [platyPS Schema](https://github.com/PowerShell/platyPS/blob/master/docs/developer/platyPS/platyPS.schema.md). Select **Preview** to view your changes as you go. Select **Edit** to go back to making updates. When you're finished making changes, select the green **Commit changes** button. - ![Select the green Commit changes button on the article editor page.](images/quick-update-editor-page.png) + ![Screenshot of how to select the green Commit changes button on the article editor page.](images/quick-update-editor-page.png) -6. In the **Propose changes** dialog that opens, review and/or enter the following values: +7. In the **Propose changes** dialog that opens, review and/or enter the following values: - **Commit message**: This value is required. You can accept the default value ("Update \") or you can change it. - **Extended description**: This value is optional. For example: - An explanation of the changes. @@ -50,17 +54,17 @@ Contributors who make infrequent or small updates can edit the file directly on When you're finished on the **Propose changes** dialog, select the green **Propose changes** button. - ![Select the green Propose changes button in the Propose changes dialog.](images/quick-update-propose-changes-dialog.png) + ![Screenshot of how to select the green Propose changes button in the Propose changes dialog.](images/quick-update-propose-changes-dialog.png) -7. On the **Comparing changes** page that opens, select the green **Create pull request** button. +8. On the **Comparing changes** page that opens, select the green **Create pull request** button. - ![Select the green Create pull request button on the Comparing changes page.](images/quick-update-comparing-changes-page.png) + ![Screenshot of how to select the green Create pull request button on the Comparing changes page.](images/quick-update-comparing-changes-page.png) -8. On the **Open a pull request** page that opens, review the title and comments, and then select the green **Create pull request** button. +9. On the **Open a pull request** page that opens, review the title and comments, and then select the green **Create pull request** button. - ![Select the green Create pull request button on the Open a pull request page.](images/quick-update-open-a-pull-request-page.png) + ![Screenshot of how to select the green Create pull request button on the Open a pull request page.](images/quick-update-open-a-pull-request-page.png) -9. That's it. There's nothing more for you to do. +10. That's it. There's nothing more for you to do. The article owner (identified in metadata) is notified about the changes to the article. Eventually, the article owner or another party will review, possibly edit, and approve your changes. After your pull request is merged, the article is updated on learn.microsoft.com. diff --git a/images/quick-update-fork-this-repository-page.png b/images/quick-update-fork-this-repository-page.png new file mode 100644 index 0000000000..3e78555ce8 Binary files /dev/null and b/images/quick-update-fork-this-repository-page.png differ diff --git a/images/quick-update-github-edit-icon.png b/images/quick-update-github-edit-icon.png new file mode 100644 index 0000000000..ba180b5f75 Binary files /dev/null and b/images/quick-update-github-edit-icon.png differ