Skip to content

Commit 15a88f0

Browse files
committed
Add simple edits using GitHub web interface section to README.
1 parent ef2e631 commit 15a88f0

File tree

4 files changed

+20
-0
lines changed

4 files changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,26 @@ A repository to hold the help reference content for Office PowerShell cmdlets.
55
Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics.
66
When you contribute your work will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet.
77

8+
# Contribute using the GitHub website (simplest)
9+
10+
## The easiest way to make a quick change is to use the GitHub website
11+
1. Open your browser, login to GitHub, and then navigate to https://github.com/microsoftdocs/office-docs-powershell
12+
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.
13+
3. Click the Edit icon which looks like a pencil in the upper right corner.
14+
![Image of Edit button on Github](images/edit_icon.png)
15+
16+
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.
17+
![Image of Edit button on Github](images/add_related_link.png)
18+
19+
**Note** that 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 top right).
20+
![Image of Automatic Fork message on Github](images/auto_fork.png)
21+
22+
5. You can click the Preview changes link to see what the changes will look like.
23+
6. Once you are satisified with your work you submit a Pull Request which asks the maintainer of the main repository (known as Upstream) to pull your edits up. To submit a Pull Request you navigate back to the main repository, https://github.com/microsoftdocs/office-docs-powershell, and click the '''New pull request''' button. You will then request your edits to be pulled up into the main repo.
24+
25+
26+
# Contribute using tools such as Git and Visual Studio Code (advanced)
27+
828
## Steps in a nutshell
929
1. Fork Office PowerShell repo to your own account.
1030
2. Clone your repo to your local development computer.

images/add_related_link.png

60.1 KB
Loading

images/auto_fork.png

155 KB
Loading

images/edit_icon.png

185 KB
Loading

0 commit comments

Comments
 (0)