Skip to content

Commit 3fa33d4

Browse files
committed
Consistency updates to README.md
1 parent 4ffeb87 commit 3fa33d4

10 files changed

+67
-44
lines changed

README.md

Lines changed: 67 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,100 @@
11
**Short URL: aka.ms/office-powershell**
22

33
# Overview
4+
45
This repository holds reference content of Office PowerShell cmdlets for help purpose. The expert knowledge around Office PowerShell is distributed among customers, MVPs, partners, product teams, support, and other community members. Consumers have various preferences when consuming knowledge such as a website, PowerShell Get-Help, Windows app, iOS app, Android app, and others. The following diagram illustrates the point.
56

67
![Contribution and Consumption model for Office PowerShell reference content](images/contrib-consumption-model.png)
78

89
## Learn How To Contribute
9-
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics.
10-
Your contributions will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet.
1110

12-
> Notice that if you are looking into contributing for the **PnP PowerShell cmdlets**, their documentation is automatically generated from the code, and you should be submitting your change towards the original code at https://github.com/SharePoint/PnP-powershell. See, for example, how the attributes are used in the code for the [Get-PnPList](https://github.com/SharePoint/PnP-PowerShell/blob/master/Commands/Lists/GetList.cs) cmdlet.
11+
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics. Your contributions will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet.
12+
13+
> [!NOTE]
14+
> If you're interested in contributing to the **PnP PowerShell** cmdlets, their documentation is automatically generated from code, and you should be submitting your change towards the original code at <https://github.com/SharePoint/PnP-powershell>. See, for example, how the attributes are used in code for the [Get-PnPList](https://github.com/SharePoint/PnP-PowerShell/blob/master/Commands/Lists/GetList.cs) cmdlet.
1315
1416
## Quick Start
1517

16-
### Contribute using the GitHub website
18+
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.
1719

18-
[![Image of Quick Start video](images/edit_video_capture.jpg)](https://support.office.com/en-us/article/edit-powershell-cmdlet-in-github-dcd20227-3764-48ce-ad6e-763af8b48daf?ui=en-US&rs=en-US&ad=US)
20+
This brief video also covers how to contribute:
1921

20-
1. Open your browser, log in to GitHub, and navigate to https://github.com/microsoftdocs/office-docs-powershell
21-
2. Browse to the file you want to edit. In this example, we will edit https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/New-Team.md and add a link in the Related Links section.
22-
3. Click the Edit icon which looks like a pencil in the upper right corner.
23-
![Image of Edit button on Github](images/edit_icon.png)
22+
[![Image of Quick Start video](images/edit_video_capture.jpg)](https://support.office.com/article/edit-powershell-cmdlet-in-github-dcd20227-3764-48ce-ad6e-763af8b48daf)
2423

25-
4. Your browser will open the file in an edit window. To add a link, we scroll down to the Related Links section and add the link in the correct format.
26-
![Image of Edit button on Github](images/add_related_link.png)
24+
### Quickly update an article using GitHub.com
2725

28-
**Note** Since you are likely not a maintainer of the Git repository, GitHub will automatically 'Fork' the project into your personal GitHub account. A fork is a copy of the repository in your git account. By forking, you can freely make edits without affecting the original repository. You can always find it again by looking at your GitHub Repositories in your GitHub Profile (drop-down from your name in the top right).
29-
![Image of Automatic Fork message on Github](images/auto_fork.png)
26+
1. Make sure you're signed in to GitHub.com with your GitHub account.
27+
2. Go to the page you want to edit on docs.microsoft.com.
28+
3. On the right-hand side of the page, click **Edit** (pencil icon).
3029

31-
5. You can click the Preview changes link to see what the changes will look like.
30+
![Edit button on docs.microsoft.com](images/quick-update-edit.png)
3231

33-
**IMPORTANT** The layout of headings and subheadings must follow a schema required for PowerShell Get-Help.
34-
Any deviation will throw errors in the Pull Request. The schema can be found here: https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md
32+
4. The corresponding topic file on GitHub opens, where you need to click the **Edit this file** pencil icon.
3533

36-
6. Once you are satisfied with your work, go to the **Propose file change** area at the bottom of the topic. Enter a title and other description information, and then click **Propose file change**.
37-
![Image of Propose file change on Github](images/propose_file_change.png)
34+
![Edit button on github.com](images/quick-update-github.png)
3835

39-
7. On the next screen, click **Create pull request**.
36+
5. The topic opens in a line-numbered editing page where you can make changes to the file.
4037

41-
Looking for more in-depth content? Check out the following:
42-
* [Frequently Asked Questions (FAQ)](repo_docs/FAQ.md)
43-
* [Using more advanced tools with the PowerShell GitHub repo](repo_docs/ADVANCED.md)
44-
* [Creating content for brand new cmdlets](repo_docs/NEW_CMDLETS.md)
38+
In this example, we'll add a link to the **Related Links** section of a topic. To add the link, scroll down to the **Related Links** section and add the link in the correct format.
4539

46-
## Microsoft Open Source Code of Conduct
40+
![Image of Edit button on Github](images/add_related_link.png)
4741

48-
### Contributing
42+
**Notes**:
43+
44+
- 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/).
45+
46+
- In cmdlet reference topics, the layout of headings and subheadings must follow a required schema for PowerShell Get-Help. Any deviation will throw errors in the Pull Request. For more information, see <https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md>.
47+
48+
- Since you are likely not a maintainer of the Git repository, GitHub will automatically 'Fork' the project into your personal GitHub account. A fork is a copy of the repository in your git account. By forking, you can freely make edits without affecting the original repository. You can always find it again by looking at your GitHub Repositories in your GitHub Profile (drop-down from your name in the top right).
49+
50+
![Image of Automatic Fork message on Github](images/auto_fork.png)
51+
52+
6. You can click the **Preview changes** tab to see what the changes will look like.
53+
54+
7. When you're finished making changes, go to the **Propose file change** section at the bottom of the page:
55+
56+
- A brief title is required. By default, the title is the name of the file, but you can change it.
57+
- Optionally, you can enter more details in the **Add an optional extended description** box.
58+
59+
When you're ready, click the green **Propose file change** button.
60+
61+
![Propose file change section](images/propose-file-change.png)
4962

50-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
51-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
52-
the rights to use your contribution. For details, visit https://cla.microsoft.com.
63+
8. On the **Comparing changes** page that appears, click the green **Create pull request** button.
5364

54-
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
55-
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
56-
provided by the bot. You will only need to do this once across all repos using our CLA.
65+
![Comparing changes page](images/comparing-changes-page.png)
66+
67+
9. On the **Open a pull request** page that appears, click the green **Create pull request** button.
68+
69+
![Open a pull request page](images/open-a-pull-request-page.png)
70+
71+
> [!NOTE]
72+
> 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.
73+
74+
Looking for more in-depth content? Check out the following topics:
75+
76+
- [Frequently Asked Questions (FAQ)](repo_docs/FAQ.md)
77+
- [Using more advanced tools with the PowerShell GitHub repo](repo_docs/ADVANCED.md)
78+
- [Creating content for brand new cmdlets](repo_docs/NEW_CMDLETS.md)
79+
80+
## Microsoft Open Source Code of Conduct
5781

5882
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
59-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
60-
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
83+
84+
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.
85+
86+
### Contributing
87+
88+
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>.
89+
90+
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.
6191

6292
## Legal Notices
6393

64-
Microsoft and any contributors grant you a license to the Microsoft documentation and other content
65-
in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode),
66-
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
67-
[LICENSE-CODE](LICENSE-CODE) file.
94+
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.
6895

69-
Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation
70-
may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries.
71-
The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks.
72-
Microsoft's general trademark guidelines can be found at https://go.microsoft.com/fwlink/?LinkID=254653.
96+
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. 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/p/?LinkID=254653>.
7397

74-
Privacy information can be found at https://privacy.microsoft.com/en-us/
98+
Privacy information can be found at <https://privacy.microsoft.com/>
7599

76-
Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents,
77-
or trademarks, whether by implication, estoppel or otherwise.
100+
Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise.

images/add_related_link.png

-19.3 KB
Loading

images/auto_fork.png

-92.1 KB
Loading

images/comparing-changes-page.png

65.2 KB
Loading

images/contrib-consumption-model.png

24.1 KB
Loading

images/edit_video_capture.jpg

-10.9 KB
Loading

images/open-a-pull-request-page.png

77.7 KB
Loading

images/propose-file-change.png

11.6 KB
Loading

images/quick-update-edit.png

11 KB
Loading

images/quick-update-github.png

11.1 KB
Loading

0 commit comments

Comments
 (0)