This repository contains the content pages of the MoodleBox website, moodlebox.net.
You're welcome to enhance the text, fix typos, etc. and to add other translations. Pages are written in Markdown format.
As for everything else in the project, the contributions to MoodleBox project are governed by our Code of Conduct.
Note: It's important that the versions of the web site in different languages are in synchronisation (i.e. have the same structure and reflect the same meaning). Your translation must be equivalent to the original content of the English pages (same structure, same meaning). If you would like to add content to a page (or change its meaning) or add new help pages, please contact me beforehand!
- Fork this repository by clicking "Fork" in the top right corner of this page.
- Clone your fork to your computer:
git clone https://github.com/<your-username>/moodlebox.net. - Duplicate the english page you want to translate (ending with
.en.md) and rename the extension with your language ISO code, e.g..de.mdfor German,.ja.mdfor Japanese,.zh.mdfor Chinese,.ru.mdfor russian, etc. - Translate the page and commit your changes:
git add *; git commit -a. - Push your changes to Github:
git push. - Create a pull request by visiting
https://github.com/<you-username>/moodlebox.netand following the instructions at the top of the screen.
The main part of the file name (before the first dot) must not be changed, as it is used to keep the page in relation with its translations, via the language switcher of the web site.
The last part of the file name, the extension .md, must also not be changed.
The only part that must be changed is the .en in between. This part has to match your language ISO code, e.g. .de for German, .ja for Japanese, .zh for Chinese, .ru for russian, etc.
Every page comes with a header, not directly displayed in the website, but very important to get correctly. These are some rules to get it right.
-
title: The title of the page. It is displayed in the main heading of the page, and serves as the title of internal links. Words of the title have too more weight in the internal search engine.
-
author: The author(s) of the page. When you edit an already existing page, please add your name after the existing name(s), with a comma, for example:
author: Jane Doe, Nicolas Martignoni
Note: The author name is not displayed anywhere on the website.
-
type: Should not be changed. Has to remain exactly identical to the english version of the translated version.
-
date: The date of the creation of a new page, in YYYY-MM-DD format, e.g.
date: 2018-01-23
Do not change it if you edit an existing page, as this is intended as a date marker of the first creation of the page.
-
weight: Should not be changed. Has to remain exactly identical to the english version of the translated version.
-
slug: Sets the permalink of the page. It should obviously be something related with the title and the content of the page. The slug should only contain lower-case characters and hyphens. No special characters, no punctuation. For a french translated page, the following slug
slug: une-page-inutile
will give the permalink
https://moodlebox.net/fr/help/une-page-inutile. -
categories: Should not be changed. Has to remain exactly identical to the english version of the translated version.
We want the MoodleBox documentation to be the best it can be. We've open-sourced the doc and we welcome any pull requests if you find it lacking. The easier way is to open an issue describing the fix to implement. Otherwise, you may use the following procedure.
- Fork this repository by clicking "Fork" in the top right corner of this page.
- Clone your fork to your computer:
git clone https://github.com/<your-username>/moodlebox.net. - Fix the typos and/or reword the text.
- Commit your changes:
git commit -a - Push your changes to Github:
git push. - Create a pull request by visiting
https://github.com/<you-username>/moodlebox.netand following the instructions at the top of the screen.