-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add information on how to contribute
- Loading branch information
Anne Fouilloux
committed
Mar 8, 2019
1 parent
a5856f0
commit a047fac
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
## How to contribute to the CTSM@UiO documentation | ||
|
||
- step 1: Fork this repository as shown in the figure below. | ||
|
||
<img src="img/fork_ctsm-docs.png" alt="Fork CTSM documentation repository"> | ||
|
||
- step 2: Go online to [CTSM documentation](https://ctsm-docs.readthedocs.io/en/latest/) and whenever you would like to update the documentation, click on "Edit on GitHub". | ||
|
||
<img src="img/edit_on_github.png" alt="Edit documentation online"> | ||
|
||
- step 3: Then click on the "pen" (see image below) and write your text ([reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html)) | ||
|
||
|
||
<img src="img/edit_in_your_fork.png" alt="Edit the file in your fork"> | ||
|
||
- step 4: Save your changes in your forked repository and create a pull request. | ||
|
||
|
||
<img src="img/propose_changes.png" alt="Propose your changes"> | ||
|
||
|
||
If you do not like to update the documentation online and prefer to use your favorite editor locally on your machine/laptop, you can skip step-3 and 4 and then clone your forked repository to edit the files locally. Once pushed to your forked github repository, you can create a pull request and propose your changes. |