Skip to content

Commit

Permalink
Merge pull request #11 from gibernas/gibernas-dev-small
Browse files Browse the repository at this point in the history
Adding procedure for small changes
  • Loading branch information
AndreaCensi authored Dec 17, 2018
2 parents b5e2ab5 + 68725d7 commit d0eb5c6
Show file tree
Hide file tree
Showing 9 changed files with 60 additions and 5 deletions.
42 changes: 38 additions & 4 deletions book/duckumentation/10_contributing/40_simple_way.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,46 @@

# The simple way to edit the documentation {#duckumentation-contribute-simple status=ready}
# The simple way to edit the documentation {#duckumentation-contribute-simple status=ready}

The simplest way to contribute to the documentation is to click any of the "✎" icons next to the headers.
The simplest way to contribute to the documentation is to click any of the "✎" icons next to the headers, in the book itself.

<div figure-id="fig:simple_way_1" figure-caption="Click on edit button.">
<img src="s1.png" style='width: 8cm'/>
</div>

They link to the "edit" page in Github. There, one can make and commit the edits in only a few seconds.
When committing, please choose "create branch".

<div figure-id="fig:simple_way_2" figure-caption="You will land on GitHub">
<img src="s2.png" style='width: 8cm'/>
</div>

Do your edits where appropriate.

<div figure-id="fig:simple_way_3" figure-caption="Editing the docs.">
<img src="s3.png" style='width: 8cm'/>
</div>


You can check the outcome by clicking on `Preview changes`, note that not all functionalities are visible by the preview. For large changes refer to [](#duckumentation-workflow).


<div figure-id="fig:simple_way_4" figure-caption="A preview of the changes.">
<img src="s4.png" style='width: 8cm'/>
</div>

Then after your edits, in the bottom part of the webpage, describe your commit and click on `Propose file change`. When committing, please choose "create branch".

<div figure-id="fig:simple_way_5" figure-caption="Describe and commit.">
<img src="s5.png" style='width: 8cm'/>
</div>

Then, click on `Create pull request`, as you probably don't have rights to push directly.

TODO for volunteer: add screenshot of process
<div figure-id="fig:simple_way_6" figure-caption="Create a pull request.">
<img src="s6.png" style='width: 8cm'/>
</div>

Again you need to confirm that you want to open the pull request.

<div figure-id="fig:simple_way_7" figure-caption="Confirm a pull request.">
<img src="s7.png" style='width: 8cm'/>
</div>
3 changes: 3 additions & 0 deletions book/duckumentation/10_contributing/simple_way_imgs/s1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions book/duckumentation/10_contributing/simple_way_imgs/s2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions book/duckumentation/10_contributing/simple_way_imgs/s3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions book/duckumentation/10_contributing/simple_way_imgs/s4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions book/duckumentation/10_contributing/simple_way_imgs/s5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions book/duckumentation/10_contributing/simple_way_imgs/s6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions book/duckumentation/10_contributing/simple_way_imgs/s7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion resources

0 comments on commit d0eb5c6

Please sign in to comment.