This is a tutorial we are using for Django Girls workshops
CSS
Clone or download
magul Merge pull request #1303 from magul/crowdin-translation-pl
Polish translation update (from Crowdin)
Latest commit 7422fff Jul 17, 2018
Permalink
Failed to load latest commit information.
.github Add pull request template Sep 21, 2017
contributing/images Moved contributing guidelines from chapter to github file. Aug 10, 2014
cs Make GitHub capitalization consistent Jun 30, 2018
de Replace {% load staticfiles %} with {% load static %} Jun 20, 2018
en Fix missing body tags in HTML Jul 17, 2018
es switch from apt-get command to apt Mar 8, 2018
fr Merge pull request #1285 from bulv1ne/master Jul 6, 2018
hu Merge pull request #1285 from bulv1ne/master Jul 6, 2018
it Make GitHub capitalization consistent Jun 30, 2018
ko Merge pull request #1285 from bulv1ne/master Jul 6, 2018
pl @w1stler proofread version from Crowdin Jul 17, 2018
pt Merge pull request #1235 from naiieandrade/master Jul 17, 2018
ru Add link to Codeacademy HTML & CSS course Jul 14, 2018
sk Fix small mistakes lost in translation Jul 17, 2018
styles Fix emoji flags on tutorial index page Jul 22, 2016
tr Sirin Saygili (https://crowdin.com/profile/saygilin) improvements fro… Jul 17, 2018
uk Merge pull request #1285 from bulv1ne/master Jul 6, 2018
zh Make GitHub capitalization consistent Jun 30, 2018
.gitignore gitignore - ignore *.swp and .idea May 8, 2018
.travis.yml Cache repository directory Sep 25, 2017
CHANGELOG.md Add Changelog Apr 2, 2015
LANGS.md Polish translation reviewed (in major part done by @w1stler) May 28, 2018
LICENSE Adding license May 24, 2016
README.md Merge pull request #1290 from rhcarvalho/github-spelling Jul 1, 2018
SUMMARY.md Fixed SUMMARY file in project root Dec 12, 2016
book.json make django version more flexiable with a gitbook variable Jul 11, 2018
cover.jpg New Gitbook covers Aug 24, 2014
cover_small.jpg New Gitbook covers Aug 24, 2014
crowdin.yaml Add %locale% to destination for target languages on Crowdin Jan 24, 2018

README.md

Django Girls Tutorial

This is the source code repository for the Django Girls Tutorial. Django Girls Tutorial is used on tutorial.djangogirls.org so if you want to read it, please go there. If you want to contribute please do go further with this file.

How to contribute

The Django Girls Tutorial is licensed under a Creative Commons Attribution-ShareAlike 4.0 license. Everyone is free to add, edit and correct the tutorial.

Editing basics

The source code of the tutorial is hosted on GitHub. The GitHub Fork & Pull workflow is used to accept and review changes.

The tutorial uses the GitBook service for publishing its documentation. See more information about how GitBook works.

The tutorial is written in Markdown mark up language.

You can find any discussions about the contents of the tutorial on the GitHub issue tracker.

Crowdin platform is used to manage translations. If you want to join an existing translation team or launch a new translation, send an email to the translation managers or contact support team. If you want to propose some small changes or fix typos in existing translations, please create a Pull Request.

Getting started and prerequisites

For contributing to the tutorial the following is needed to get started:

Fork the repository

First fork the DjangoGirls/tutorial repository to your personal GitHub account:

Fork button

Editing chapter content

Simple changes

For simple changes like typo corrections you can use the GitHub online editor:

  • Open your local fork page on GitHub,
  • go to README.md file in any chapter,
  • press the Edit icon (pen)

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

Edit button

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

GitHub editor

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

New content and complex changes

For adding new chapters, writing longer snippets of text or adding images, you need to get a copy of the tutorial to your local computer.

Either use the GitHub app for your operating system (mentioned above) or git command line to get the repository locally. You get the repository address from the front page of your own GitHub repository fork:

git clone git@github.com:yourgithubusername/tutorial.git

Then, create a branch for your new changes to sit in. It helps to call the branch something related to the changes you are going to make.

git checkout -b contributing

Download the GitBook Editor app to your computer.

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

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

Then commit the changes using git and push the changes to your remote GitHub repository.

Example:

$ git status
On branch contributing
Untracked files:
  (use "git add <file>..." to include in what will be committed)

    contributing_and_editing_this_book/images/gitbook.png

$ git add contributing_and_editing_this_book/images/gitbook.png

$ git commit -m "Added gitbook editor screenshot"
[contributing fe36152] Added gitbook screenshot
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 contributing_and_editing_this_book/images/gitbook.png

$ git push
Counting objects: 11, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (5/5), done.
Writing objects: 100% (5/5), 266.37 KiB | 0 bytes/s, done.
Total 5 (delta 1), reused 0 (delta 0)
To git@github.com:miohtama/tutorial.git
   b37ca59..fe36152  contributing -> contributing

If you don't want to download the GitBook Editor app you can also go to the GitBook website, sign up for free and work directly in your browser.

Making a pull request

After you have finished your changes you need to create a pull request on GitHub. DjangoGirls will get notified about the pull request, review your changes, suggest any corrections if needed and then pull your changes to the master version.

In your own repository on GitHub press do Compare & pull request

Compare & pull request

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.

Then press Create pull request.

GitHub emails will notify you for the follow up process.

Further information and help

GitHub has an excellent documentation. Check it out if you need help!

For further questions please contact DjangoGirls.