what to substitute

[pts]

In some of the code examples it's not obvious what should be typed verbatim and what should be substituted (personalized). Some participants got it wrong last time during the workshop.

For example, on https://tutorial.djangogirls.org/en/deploy/ has

$ git init
Initialized empty Git repository in ~/djangogirls/.git/
$ git config --global user.name "Your Name"
$ git config --global user.email [email protected]

Many participants tried to substitute user.name with their GitHub username, and got an error message.

We should visually indicate everything which needs to be substituted, such as italics and underline and angle brackets:

$ git init Initialized empty Git repository in ~/djangogirls/.git/ $ git config --global user.name "<your-name>" $ git config --global user.email <[email protected]>

(Sorry about the additional spaces and the missing underline above, GitHub Markdown doesn't let me do it.)

For each substitution, we should add an explanation:

• <your-name> should be substituted with your full name, such as Jane Doe. This will be shared with the general public on GitHub. If you don't feel comfortable with sharing it, just use your GitHub username instead.

• <[email protected]> should be substituted with your e-mail address. This will be shared with the general public on GitHub. If you do't feel comfortable with sharing it, just use your GitHub username with @secret appended instead.

There are other instaces in the tutorial where substitution should occur. The tutorial should distinguish them visually and it should also explain all of them explicitly.