Skip to content

Commit 21cfa0f

Browse files
skaggejVesaJuvonen
authored andcommitted
Fixed broken links, added referenced images, and updated content accuracy. (#3489)
* Fixed some links, added missing images folder with images. * Added some contribution images and updated guidance. * Removed additional space
1 parent 65067e6 commit 21cfa0f

6 files changed

+19
-14
lines changed

.github/CONTRIBUTING.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Contribute to SharePoint developer documentation
2-
Below instructions explain how you can prepare your environment to contribute to SharePoint Developer Documentation.
2+
These instructions explain how you can prepare your environment to contribute to SharePoint Developer Documentation.
33

44
## Docs repo structure
55

66
Before you decide to contribute, it is important to understand the `sp-dev-docs` repo structure so you can decide where to add your new doc or update an existing doc.
77

88
```
99
sp-dev-docs
10-
--images
10+
--assets
1111
--docs
12+
--general-development
13+
--images
1214
```
1315

1416
The `docs` folder contains the key developer topics:
@@ -30,20 +32,20 @@ The `spfx` folder contains documentation for SharePoint Framework. It is further
3032
```
3133
docs
3234
--spfx
33-
---webparts
35+
---web-parts
3436
-----basics
3537
-----get-started
36-
-----developer-guide
38+
-----guidance
3739
```
3840

3941
#### Component folder
4042
Every component folder contains the following folders:
4143
* basics
42-
* `basics` folder contains concept docs that are helpful in building that particular component, for example: `web parts`.
44+
* `basics` folder contains concept docs that are helpful in building that particular component, for example: `web-parts`.
4345
* get-started
44-
* `get-started` folder contains walkthroughs and tutorials on how to get started building that particular component, for example: `web parts`.
45-
* developer-guide
46-
* `developer-guide` folder contains guides, best practices and reference implementations for that particular component, for example: `web parts`.
46+
* `get-started` folder contains walkthroughs and tutorials on how to get started building that particular component, for example: `web-parts`.
47+
* guidance
48+
* `guidance` folder contains guides, best practices and reference implementations for that particular component, for example: `web-parts`.
4749
*
4850
Any images associated with the docs should be uploaded into the `sp-dev-docs\images` folder.
4951

@@ -80,9 +82,10 @@ Now that you have forked the docs repository, to sync this forked repository to
8082

8183
![Clone the forked SharePoint developer docs repository](../images/contribute-docs-clone-options.png)
8284

83-
If you have any Git Desktop or any git source control installed, you can click the `Open is Desktop`, else follow the steps below:
85+
If you have any Git Desktop or any git source control installed, you can click the `Open in Desktop` or follow the steps below:
8486

85-
In the Clone with HTTPs section, click to copy the clone URL for the repository.
87+
In the `Clone with HTTPs` section, click ![](../images/contribute-clone-icon.png)
88+
to copy the clone URL for the repository.
8689

8790
* Open your favorite console terminal.
8891

@@ -132,16 +135,18 @@ Once you have completed adding your changes, you can submit a pull request.
132135

133136
Navigate to the forked sp-dev-docs repo in your account. Make sure your current branch is `master` branch.
134137

135-
Once you are in the `master` branch, you should see a message to `Compare & pull request`
138+
Once you are in the `master` branch, you should see a message stating `This branch is 1 commit ahead of SharePoint:master` and next to it will be a `Pull request` link.
136139

137140
![Submit a pull request to sp-dev-docs repo](../images/contribute-docs-submit-pr.png)
138141

139-
This will start a new pull request. Make sure you use the following [template]() to fill in your changes. Make sure you are creating this pull request against the `master` branch.
142+
Click the `Pull request` link to start a new pull request. Make sure you use this [template](PULL_REQUEST_TEMPLATE.md) to fill in your changes. Make sure you are creating this pull request against the `master` branch.
143+
144+
Once you have all the information, click the `Create pull request` button to submit your pull request.
140145

141-
Once you have all the information, click the `Create pull request` to submit your pull request.
146+
![Create pull request](../images/contribute-docs-create-pr.png)
142147

143148
## Syncing your forked repository to keep it up-to-date with the upstream repository
144149

145150
In order to keep your forked sp-dev-docs repo up-to-date with the parent repository, you will need to first [configure a remote that points to upstream repository](https://help.github.com/articles/configuring-a-remote-for-a-fork).
146151

147-
Once you have configured the upstream repository, follow the steps [here](https://help.github.com/articles/configuring-a-remote-for-a-fork) to sync your fork to keep it up-to-date with the upstream repository.
152+
Once you have configured the upstream repository, follow the steps [here](https://help.github.com/en/articles/syncing-a-fork) to sync your fork to keep it up-to-date with the upstream repository.

images/contribute-clone-icon.png

778 Bytes
Loading
1.5 KB
Loading

images/contribute-docs-create-pr.png

1.98 KB
Loading

images/contribute-docs-submit-pr.png

3.67 KB
Loading

images/contribute-fork-docs-repo.png

8.86 KB
Loading

0 commit comments

Comments
 (0)