Skip to content

Commit

Permalink
Moved contributing guidelines from chapter to github file.
Browse files Browse the repository at this point in the history
  • Loading branch information
olasitarska committed Aug 10, 2014
1 parent dbc106f commit b816218
Show file tree
Hide file tree
Showing 9 changed files with 9 additions and 10 deletions.
12 changes: 6 additions & 6 deletions contributing_and_editing_this_book/README.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Django Girls Tutorial is licensed under a *Creative Commons Attribution-Shar

# Editing basics

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.
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.

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/).

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

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

![Fork button](images/fork.png)
![Fork button](contributing/images/fork.png)

# Editing chapter content

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

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

![Edit button](images/edit.png)
![Edit button](contributing/images/edit.png)

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

![Github editor](images/github_editor.png)
![Github editor](contributing/images/github_editor.png)

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

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

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

![Gitbook](images/gitbook.png)
![Gitbook](contributing/images/gitbook.png)

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

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

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

![Gitbook](images/pull_request.png)
![Gitbook](contributing/images/pull_request.png)

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.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ OK, [let's start at the beginning...](how_internet_works/README.md)

## About and contributing

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).
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).
1 change: 0 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,4 @@
* [Django Forms](django_forms/README.md)
* [Domain](domain/README.md)
* [What's next?](whats_next/README.md)
* [Contributing and editing](contributing_and_editing_this_book/README.md)

4 changes: 2 additions & 2 deletions book.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
{
"links": {
"home": false,
"about": "http://djangogirls.org",
"issues": false,
"contribute": "http://tutorial.djangogirls.org/contributing_and_editing_this_book/README.html",
"contribute": "http://github.com/DjangoGirls/tutorial/CONTRIBUTING.md",

"custom": {
"Django documentation": "http://docs.djangoproject.com"
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit b816218

Please sign in to comment.