|
| 1 | +--- |
| 2 | +ms.date: 9/15/2023 |
| 3 | +--- |
| 4 | + |
1 | 5 | # Overview |
2 | 6 |
|
3 | 7 | ## Learn how to contribute |
4 | 8 |
|
5 | | -Anyone who is interested can contribute to the topics. When you contribute, your work will go directly into the content set after being merged. It will then be published to [Microsoft Learn](https://learn.microsoft.com/) and you will be listed as a contributor at: <https://github.com/MicrosoftDocs/office-docs-powershell/graphs/contributors>. |
| 9 | +Anyone who is interested can contribute to the articles. When you contribute, your work goes into the content set after it's been reviewed and merged. It's then published to [Microsoft Learn](https://learn.microsoft.com/), and you're listed as a contributor at: <https://github.com/MicrosoftDocs/office-docs-powershell/graphs/contributors>. |
6 | 10 |
|
7 | 11 | ### Quickly update an article using GitHub.com |
8 | 12 |
|
9 | | -Contributors who only make infrequent or small updates can edit the file directly on GitHub.com without having to install any additional software. This article shows you how. [This two-minute video](https://www.microsoft.com/videoplayer/embed/RE1XQTG) also covers how to contribute. |
| 13 | +Contributors who make infrequent or small updates can edit the file directly on GitHub.com without installing any software. This article shows you how. [This two-minute video](https://www.microsoft.com/videoplayer/embed/RE1XQTG) also covers how to contribute. |
| 14 | + |
| 15 | +> [!TIP] |
| 16 | +> To edit an article, you need to get to it on the GitHub.com backend. If you're already on the GitHub.com page of the article, you're starting at step 4. |
| 17 | +> |
| 18 | +> Your permissions in the repo determine what you see in step 5 and later. People with no special privileges see the steps as described. People with permissions to approve their own pull requests see a similar experience with different button and page titles (for example, **Commit changes** instead of **Propose changes**), extra options for creating a new branch, and fewer confirmation pages. The point is: click any green buttons that are presented to you until there are no more. |
| 19 | +
|
| 20 | +1. Verify that you're signed in to GitHub.com with your GitHub account. |
| 21 | +2. On learn.microsoft.com, find the article that you want to update. |
| 22 | +3. Above the title of the article, select  **Edit this document**. |
| 23 | + |
| 24 | +  |
| 25 | + |
| 26 | +4. The corresponding article file opens on GitHub. Select  **Edit this file**. |
| 27 | + |
| 28 | +  |
10 | 29 |
|
11 | | -1. Make sure you're signed in to GitHub.com with your GitHub account. |
12 | | -2. Browse to the page you want to edit on Microsoft Learn. |
13 | | -3. On the right-hand side of the page, click **Edit** (pencil icon). |
| 30 | +5. The article file opens in a line-numbered editor page where you can make updates. |
14 | 31 |
|
15 | | -  |
| 32 | + 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/). |
16 | 33 |
|
17 | | -4. The corresponding topic file on GitHub opens, where you need to click the **Edit this file** pencil icon. |
| 34 | + > [!TIP] |
| 35 | + > 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 <CmdletName`). Use existing content as a guide. For more information, see [platyPS Schema](https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md). |
18 | 36 |
|
19 | | -  |
| 37 | + Select **Preview** to view your changes as you go. Select **Edit** to go back to making updates. |
20 | 38 |
|
21 | | -5. The topic opens in a line-numbered editing page where you can make changes to the file. Files in GitHub are written and edited using Markdown language. For help on using Markdown, see [Mastering Markdown](https://guides.github.com/features/mastering-markdown/). Select the **Preview changes** tab to view your changes as you go. |
| 39 | + When you're finished making changes, select the green **Commit changes** button. |
22 | 40 |
|
23 | | -6. When you're finished making changes, go to the **Propose file change** section at the bottom of the page: |
| 41 | +  |
24 | 42 |
|
25 | | - - A brief title is required. By default, the title is the name of the file, but you can change it. |
26 | | - - Optionally, you can enter more details in the **Add an optional extended description** box. |
| 43 | +6. In the **Propose changes** dialog that opens, review and/or enter the following values: |
| 44 | + - **Commit message**: This value is required. You can accept the default value ("Update \<filename\>") or you can change it. |
| 45 | + - **Extended description**: This value is optional. For example: |
| 46 | + - An explanation of the changes. |
| 47 | + - @ include the GitHub alias of someone to review and merge your changes. |
27 | 48 |
|
28 | | - When you're ready, click the green **Propose file change** button. |
| 49 | + When you're finished on the **Propose changes** dialog, select the green **Propose changes** button. |
29 | 50 |
|
30 | | -  |
| 51 | +  |
31 | 52 |
|
32 | | -7. On the **Comparing changes** page that appears, click the green **Create pull request** button. |
| 53 | +7. On the **Comparing changes** page that opens, select the green **Create pull request** button. |
33 | 54 |
|
34 | | -  |
| 55 | +  |
35 | 56 |
|
36 | | -8. On the **Open a pull request** page that appears, click the green **Create pull request** button. |
| 57 | +8. On the **Open a pull request** page that opens, review the title and comments, and then select the green **Create pull request** button. |
37 | 58 |
|
38 | | -  |
| 59 | +  |
39 | 60 |
|
40 | | -> [!NOTE] |
41 | | -> Your permissions in the repo determine what you see in the last several steps. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages.<br/><br/>The point is: click any green buttons that are presented to you until there are no more. |
| 61 | +9. That's it. There's nothing more for you to do. |
42 | 62 |
|
43 | | -The writer identified in the metadata of the topic will be notified and will eventually review and approve your changes so the topic will be updated on Microsoft Learn. If there are questions or issues with the updates, the writer will contact you. |
| 63 | + 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. |
44 | 64 |
|
45 | 65 | ## Microsoft Open Source Code of Conduct |
46 | 66 |
|
47 | 67 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
48 | 68 |
|
49 | | -For more information see the [Code of Conduct FAQ ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. |
| 69 | +For more information , see the [Code of Conduct FAQ ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any questions or comments. |
50 | 70 |
|
51 | 71 | ### Contributing |
52 | 72 |
|
53 | 73 | This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.microsoft.com>. |
54 | 74 |
|
55 | | -When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. |
| 75 | +When you submit a pull request, a CLA-bot automatically determines whether you need to provide a CLA and decorate the PR appropriately (for example, label, comment). Follow the instructions provided by the bot. You only need to do this step once across all repos using our CLA. |
56 | 76 |
|
57 | 77 | ### Legal Notices |
58 | 78 |
|
59 | 79 | Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the [LICENSE-CODE](LICENSE-CODE) file. |
60 | 80 |
|
61 | | -Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. |
| 81 | +Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries/regions. |
62 | 82 |
|
63 | | -The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at <https://go.microsoft.com/fwlink/?LinkID=254653>. |
| 83 | +The licenses for this project don't grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at <https://go.microsoft.com/fwlink/?LinkID=254653>. |
64 | 84 |
|
65 | 85 | Privacy information can be found at <https://privacy.microsoft.com/> |
66 | 86 |
|
|
0 commit comments