Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
75 lines (51 sloc) 4.95 KB

Website moodlebox.net

Build Status

This repository contains the content pages of the MoodleBox website, moodlebox.net.

Contributing

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.

How to contribute a new language translation

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!

  1. Fork this repository by clicking "Fork" in the top right corner of this page.
  2. Clone your fork to your computer: git clone https://github.com/<your-username>/moodlebox.net.
  3. Duplicate the folder containing the english content of the website. This folder is located here: content/en. Rename the duplicated folder with your language ISO code, e.g. es for Spanish, ja for Japanese, zh for Chinese, ru for russian, etc. Don't change the hierarchic structure of your new folder.
  4. Open the page(s) you want to translate with a text editor, translate it (them) and save. Do not change the filenames. Then commit your changes, e.g.: git add content/es/<name-of-the-translated-page>.md ; git commit -a. Don't commit the files you didn't translate yet.
  5. Push your changes to Github: git push.
  6. Create a pull request by visiting https://github.com/<your-username>/moodlebox.net and following the instructions at the top of the screen.

What about the file names?

The file names, including the extension .md, must absolutely not be changed, as they are used to keep the page in relation with its translations, via the language switcher of the web site.

What to do with the header of the file?

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, to be translated in your language. It is displayed in the main heading of the page, and serves as the title of internal links. Words of the title have also more weight in the internal search engine.

  • authors: The author(s) of the page. When you edit an already existing page, please add your name on a new line after the existing name(s), with a dash, for example:

    authors:
      - 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-12-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, in your language. 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.

How to fix typos or enhance an existing translation?

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.

  1. Fork this repository by clicking "Fork" in the top right corner of this page.
  2. Clone your fork to your computer: git clone https://github.com/<your-username>/moodlebox.net.
  3. Fix the typos and/or reword the text.
  4. Commit your changes: git commit -a
  5. Push your changes to Github: git push.
  6. Create a pull request by visiting https://github.com/<your-username>/moodlebox.net and following the instructions at the top of the screen.