diff --git a/contributing_and_editing_this_book/README.md b/CONTRIBUTING.md similarity index 89% rename from contributing_and_editing_this_book/README.md rename to CONTRIBUTING.md index c6c33e9cef0..e3f2deca667 100644 --- a/contributing_and_editing_this_book/README.md +++ b/CONTRIBUTING.md @@ -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/). @@ -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 @@ -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. @@ -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*). @@ -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. diff --git a/README.md b/README.md index 377a24e621f..e99068a06c2 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/SUMMARY.md b/SUMMARY.md index 4a02d7e729c..1bea31cbbfa 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -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) diff --git a/book.json b/book.json index 1c0c5c1e3b3..94a0f7f5009 100644 --- a/book.json +++ b/book.json @@ -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" diff --git a/contributing_and_editing_this_book/images/edit.png b/contributing/images/edit.png similarity index 100% rename from contributing_and_editing_this_book/images/edit.png rename to contributing/images/edit.png diff --git a/contributing_and_editing_this_book/images/fork.png b/contributing/images/fork.png similarity index 100% rename from contributing_and_editing_this_book/images/fork.png rename to contributing/images/fork.png diff --git a/contributing_and_editing_this_book/images/gitbook.png b/contributing/images/gitbook.png similarity index 100% rename from contributing_and_editing_this_book/images/gitbook.png rename to contributing/images/gitbook.png diff --git a/contributing_and_editing_this_book/images/github_editor.png b/contributing/images/github_editor.png similarity index 100% rename from contributing_and_editing_this_book/images/github_editor.png rename to contributing/images/github_editor.png diff --git a/contributing_and_editing_this_book/images/pull_request.png b/contributing/images/pull_request.png similarity index 100% rename from contributing_and_editing_this_book/images/pull_request.png rename to contributing/images/pull_request.png