Adding a term to the glossary
Each glossary (meaning, each translated instance of the glossary), has three components:
- A layout template for the glossary homepage: 'glossary.html'
- A layout template for the glossary in each language: 'glossary/{lang}/index.md'
- A directory of the glossary terms. Each term in the directory is listed as the url slug (In English, all lower case letters, and hyphens instead of white spaces).
1: Create a folder for the term
Log - in to Github and go to this link
You will see a the branch name (“gh-pages”) and a directory. You will also see the breadcrumb community.openspending.org / glossary / en / terms / +
. Click on the "+" to create a new folder.
Write the name of the term that you want to add in a new slug (In English, all lower case letters, and hyphens instead of white spaces) and add a “/” at the end of the terms name. This will create a new folder name.
2: Create a file for your term
Now you will see the breadcrumb - community.openspending.org / glossary / en / terms / your-new-term / +
Click on the “+” sign again. Now write in the path “index.md”. This will save the whole file as a markdown file.
3: Write the term definition
In the text editor below, add the front matter (Jekyll way to mark the page) -
--- section: terms lang: en title: // the term name // ---Write the term definition after the front matter as usual.
4: Make a pull request
Click on “Create a new branch for this commit and start a pull request.” This will allow us to review your changes.
Thank you! All done! If the handbook editors are happy with your term, it will be added to the glossary.
- Improve this page Edit on Github Help and instructions
-
Donate
If you have found this useful and would like to support our work please consider making a small donation.