Skip to content

Commit b816218

Browse files
committed
Moved contributing guidelines from chapter to github file.
1 parent dbc106f commit b816218

9 files changed

Lines changed: 9 additions & 10 deletions

File tree

contributing_and_editing_this_book/README.md renamed to CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Django Girls Tutorial is licensed under a *Creative Commons Attribution-Shar
44

55
# Editing basics
66

7-
The source code of the tutorial is [hosted on Github](). The Github [Fork & Pull workflow](https://help.github.com/articles/using-pull-requests) is used to accept and review changes.
7+
The source code of the tutorial is [hosted on Github](http://github.com/DjangoGirls/tutorial). The Github [Fork & Pull workflow](https://help.github.com/articles/using-pull-requests) is used to accept and review changes.
88

99
The tutorial uses the [GitBook](https://www.gitbook.io/) service for publishing its documentation. [See more information about how Gitbook works](http://help.gitbook.io/).
1010

@@ -23,7 +23,7 @@ For contributing to the tutorial the following is needed to get started:
2323

2424
First fork the [DjangoGirls/tutorial](https://github.com/DjangoGirls/tutorial) repository to your personal Github account:
2525

26-
![Fork button](images/fork.png)
26+
![Fork button](contributing/images/fork.png)
2727

2828
# Editing chapter content
2929

@@ -37,11 +37,11 @@ For simple changes like typo corrections you can use the Github online editor:
3737

3838
and you can edit the chapter directly on github.com.
3939

40-
![Edit button](images/edit.png)
40+
![Edit button](contributing/images/edit.png)
4141

4242
Markdown syntax is used to edit the individual pages of the tutorial.
4343

44-
![Github editor](images/github_editor.png)
44+
![Github editor](contributing/images/github_editor.png)
4545

4646
Save your changes and create a pull request as explained below.
4747

@@ -57,7 +57,7 @@ Download the [Gitbook Editor](http://help.gitbook.io/editor/README.html) app to
5757

5858
Then you can open the tutorial in Gitbook Editor (*File* > *Open book*).
5959

60-
![Gitbook](images/gitbook.png)
60+
![Gitbook](contributing/images/gitbook.png)
6161

6262
Make any changes in the tutorial using the editor and then save changes (*Book* > *Save all*).
6363

@@ -94,7 +94,7 @@ After you have finished your changes you need to create [a pull request](https:/
9494

9595
In your own repository on Github press do *Compare & pull request*
9696

97-
![Gitbook](images/pull_request.png)
97+
![Gitbook](contributing/images/pull_request.png)
9898

9999
Fill in the information *why* this change is being made. The reviewer can see the details of the actual change, so you don't need repeat the content of the change.
100100

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ OK, [let's start at the beginning...](how_internet_works/README.md)
2727

2828
## About and contributing
2929

30-
This tutorial is maintained by [DjangoGirls](http://djangogirls.org/). If you find any mistakes or want to update the tutorial please [follow the contributing guidelines](contributing_and_editing_this_book/README.md).
30+
This tutorial is maintained by [DjangoGirls](http://djangogirls.org/). If you find any mistakes or want to update the tutorial please [follow the contributing guidelines](http://github.com/DjangoGirls/tutorial/CONTRIBUTING.md).

SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,4 @@
2323
* [Django Forms](django_forms/README.md)
2424
* [Domain](domain/README.md)
2525
* [What's next?](whats_next/README.md)
26-
* [Contributing and editing](contributing_and_editing_this_book/README.md)
2726

book.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
{
1+
{
22
"links": {
33
"home": false,
44
"about": "http://djangogirls.org",
55
"issues": false,
6-
"contribute": "http://tutorial.djangogirls.org/contributing_and_editing_this_book/README.html",
6+
"contribute": "http://github.com/DjangoGirls/tutorial/CONTRIBUTING.md",
77

88
"custom": {
99
"Django documentation": "http://docs.djangoproject.com"

contributing_and_editing_this_book/images/edit.png renamed to contributing/images/edit.png

File renamed without changes.

contributing_and_editing_this_book/images/fork.png renamed to contributing/images/fork.png

File renamed without changes.

contributing_and_editing_this_book/images/gitbook.png renamed to contributing/images/gitbook.png

File renamed without changes.

contributing_and_editing_this_book/images/github_editor.png renamed to contributing/images/github_editor.png

File renamed without changes.

contributing_and_editing_this_book/images/pull_request.png renamed to contributing/images/pull_request.png

File renamed without changes.

0 commit comments

Comments
 (0)