Skip to content
This repository was archived by the owner on Feb 20, 2022. It is now read-only.

Commit 3a4bfcc

Browse files
authored
Made README.md more concise
1 parent 893cfcd commit 3a4bfcc

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Short URL: aka.ms/office-powershell
22

33
# Overview
4-
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 also 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.
4+
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.
55
![Contribution and Consumption model for Office PowerShell reference content](images/contrib-consumption-model.png)
66

77
# Learn How To Contribute
88
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics.
9-
When you contribute your work will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet.
9+
Your contributions will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet.
1010

1111
> 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.
1212
@@ -16,20 +16,20 @@ When you contribute your work will go directly into the Microsoft Office product
1616

1717
[![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)
1818

19-
1. Open your browser, log in to GitHub, and then navigate to https://github.com/microsoftdocs/office-docs-powershell
19+
1. Open your browser, log in to GitHub, and navigate to https://github.com/microsoftdocs/office-docs-powershell
2020
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.
2121
3. Click the Edit icon which looks like a pencil in the upper right corner.
2222
![Image of Edit button on Github](images/edit_icon.png)
2323

24-
4. Your browser will then open the file in an edit window. We want to add a link. So we scroll down to the Related Links section and add the link in the correct format.
24+
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.
2525
![Image of Edit button on Github](images/add_related_link.png)
2626

27-
**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 just an exact copy of the repository in your own account so that you have total access to make edits. You are now 'editing' a copy of the project in your own GitHub account. 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).
27+
**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).
2828
![Image of Automatic Fork message on Github](images/auto_fork.png)
2929

3030
5. You can click the Preview changes link to see what the changes will look like.
3131

32-
**IMPORTANT** The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help.
32+
**IMPORTANT** The layout of headings and subheadings must follow a schema required for PowerShell Get-Help.
3333
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
3434

3535
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**.

0 commit comments

Comments
 (0)