Skip to content

Propose your translated article

Nolwenn Poirier edited this page Sep 19, 2018 · 1 revision

1. Create a Github account

First things first, you'll need a Github account. Cause you're going to create pull requests (or PRs) like a grownup. 😉

2. Choose the article you wanna translate

The help center is composed of many articles. It would be wonderful if you could translate each one of them, but we are well aware that we are not living in a Disney movie, so if you begin with at least one article, it would be a great first step. 😄

So, you'll have to choose the article(s) you are going to translate.
Some pro tips:

  • You can find the articles in the content/md folder, as you can see in the GIF below.

Articles folders

They are distributed in the different folders. Don't hesitate to browse them all in order to find the perfect article to translate.

  • All articles do not have the same length. The shorter is only 22 lines long, the bigger has more than 300 lines. As we will only accept articles that are entirely translated, please choose one that you know you'll be able to fully translate.
  • Check that the article you choose is not already/being translated in the following wonderful file (French only for now).

3. Create a new file

Now, it's time to create a file. To do so, in the Github interface, click on the Create a new file button in the same folder in which is located the English version of the article.

Pick a name

As shown in the above screenshot, Github will then ask you for a file name. Let's take an example. Let's say you want to translate it into German and the name of the English version of the article is i-love-britney-spears_en.md. Your new file should then be called i-love-britney-spears_de.md. If you want to translate it into French, create a file named i-love-britney-spears_fr.md.

4. Learn how to write Markdown

Our articles are written in Markdown. If you don't know yet how to write in this format, they are wonderful guides available on the Internet to help you get started, like this cheatsheet. You'll see, it's a simple format.

5. Initialise your file

In a new browser tab (yolo!), open the English version of your article, click on the Raw button and copy the whole content.

Go back to your previous tab, where you were creating your article and paste this content into the Edit new file section.

6. Translate the headers information

The header part of your article is easy to locate, it's the part surrounded by --- blocks and it is always at the top of the content. Pretty logic for a header, don't you think? 😉

In this header, there is only one information to translate: it's the title of the article. You'll find it after the title: string. Just replace the existing English title with your amazing translation.

FYI, this title will appear at the top of the article in the help center website and it will be used as links in the "Themes" pages.

You can put some words in bold inside the title by using the following syntax **bold**. If the first word of your title is a bold word, you will have to use quotes to make it work. Example: title: "**Crazy** is this title".

You don't need to translate anything else in this header. So DON'T touch anything else.

7. Translate the article content

After the end of the header, you'll find the content of the article. As you copy-pasted it from the English version, well, it's totally in English.

Your job is now to translate everything into your language.

Some pro tips:

  • Don't forget to follow the Markdown format.
  • To fully understand how the content is made up, don't hesitate to browse this section of documentation.
  • There are some things that you don't need to translate because they are part of the format (Markdown + our extras), so be sure to understand what is part of the format (that shouldn't be translated) and what is part of the article content (that you should translate). Here, is an example. Let's say you find this in your article:
    Britney [forever](https://britney.forever). In the Markdown format, this is a sentence (a weird one, yes, but still) with a link to an external website at the end. You should only translate the words Britney and forever. Don't touch the link. Even if you're dying to do so.
  • You can click on the Preview button to get a preview of your article. Don't panic if you see that images and special blocks (warning, info, tips,...) are not well rendered, it's ok. They will look amazing on the help center website.

8. Create your PR

When you are satisfied with your article translation, you can submit it for reviewal by creating a Pull Request (PR).
To do so:

  1. Scroll down to the end of the page and complete the Propose new file section like shown in the following screenshot.
    Propose new file - step 1
  2. Click on the Propose new file button.
  3. Then, a new page is loaded. Click on the Create pull request button at the top of the page.
    Propose new file - step 2
  4. Then, again, on the next page, click on the Create pull request button.
    Propose new file - step 3

Perfect! Your Pull Request is now created!
You can see in the following screenshot, what your PR should look like.

Propose new file - step 4