Make a glossary

[olasitarska]

Gitbook has a nice feature of making glossaries and it automatically links the words to their explanations. We need to add GLOSSARY.md file in the main directory and the structure of the file is really simple:

# Keyword
Explanation

# Keyword
Explanation

[olasitarska]

Thanks for starting this @aniav! I'm gonna reopen this one -- we should fill out the glossary with terms from the tutorial for this to be really closed :)

[aspigirlcodes]

I started making a list of terms. I did some explanations as well but i would like to ask everybody to do one or 2. i think i'll do that in slack.

[cgl]

@githubsara how can we help? Do you have a branch with your updates?

[aspigirlcodes]

Sadly I got overrun by my work for the university. I even didn't make a branch yet. But here is the file with the words I collected from the tutorial. GLOSSARY.txt

[das-g]

But here is the file with the words I collected from the tutorial. GLOSSARY.txt

Is that available on any Git branch or GitHub fork, yet? If not, let's create one, so people can more easily contribute definitions/explanations.

[magul]

I believe we do @das-g (but it pretty short): https://github.com/DjangoGirls/tutorial/blob/master/en/GLOSSARY.md

[das-g]

I believe we do @das-g (but it pretty short): https://github.com/DjangoGirls/tutorial/blob/master/en/GLOSSARY.md

I've seen that. What I meant is: Is that version by @aspigirlcodes (with many more terms, but most of them still lacking definitions) available on any Git branch or GitHub fork, yet?

[aspigirlcodes]

I don't think it is, and I am currently not in a position to invest time in it. If you can, go ahead and use it. I am sorry that I cannot give more info or get involved in anything right now

2018-03-16 10:44 GMT+01:00 Raphael Das Gupta notifications@github.com:

I believe we do @das-g https://github.com/das-g (but it pretty short): https://github.com/DjangoGirls/tutorial/blob/master/en/GLOSSARY.md

I've seen that. What I meant is: Is that version https://github.com/DjangoGirls/tutorial/files/636771/GLOSSARY.txt by @aspigirlcodes https://github.com/aspigirlcodes (with many more terms, but most of them still lacking definitions) available on any Git branch or GitHub fork, yet?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/DjangoGirls/tutorial/issues/123#issuecomment-373657833, or mute the thread https://github.com/notifications/unsubscribe-auth/AIbDgD5rDUlSeHIKQ4r5-aJJKHcyN1SWks5te4l5gaJpZM4Cff4T .

[das-g]

If you can, go ahead and use it.

I will. :smiley:

I don't think it is, and I am currently not in a position to invest time in it. [...] I am sorry that I cannot give more info or get involved in anything right now

That's alright. I appreciate that you started this, @aspigirlcodes. The beauty of free content is that we can pick up each other's work and each other's work-in-progress.

[das-g]

https://github.com/das-g/django-girls-tutorial/tree/glossary

[gconnect]

I am new to open source, and am a big fan of Django girls and I would love to contribute to the make a glossary issue #123. What do I need to do to get started?

[das-g]

Hi @gconnect.

If you want to write a definition/description for one of the terms in https://github.com/das-g/django-girls-tutorial/blob/glossary/en/GLOSSARY.md, click the pen icon there to edit a copy of the file. (This will create your own "fork" of the repository, if you haven't one already on GitHub.) When saving your changes, you'll first be asked for a commit message (describe/summarize the change/addition there) and then whether you want to create a pull request. Follow through with the pull request. (You'll probably have to fill in a title and another description.)

If you want to add a new term, you can follow the same procedure from https://github.com/DjangoGirls/tutorial/blob/master/en/GLOSSARY.md on.

[gconnect]

I am new to open source, and am a big fan of Django girls and I would love to contribute to the make a glossary issue #123. What do I need to do to get started?

[magul]

Is @das-g answer insufficient? @gconnect

[das-g]

I guess this is re das-g/django-girls-tutorial#2

What my instructions above didn't yet mention: If you want to make a pull request from an existing branch of yours, you'll have to specify the correct target branch. If your own branch was created from my glossary branch, my glossary branch should also be the target of the pull request.

I guess the commit you wanted to contribute to the glossary is fbbbfc6. If that's the case and if you're unsure how to do the above, you can instead simply go to https://github.com/das-g/django-girls-tutorial/compare/glossary...gconnect:patch-3 and click "create pull request" there and it'll target the right branch (because it's encoded in that link already).