From ffca835231869dcaa333c6b81fb72e045a4af07d Mon Sep 17 00:00:00 2001 From: mrugesh mohapatra <1884376+raisedadead@users.noreply.github.com> Date: Thu, 22 Nov 2018 01:10:19 +0530 Subject: [PATCH] docs: update instructions for translations --- docs/style-guide-for-guide-articles.md | 30 +++++++++++--------------- 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/docs/style-guide-for-guide-articles.md b/docs/style-guide-for-guide-articles.md index edc50cf858..912503d66f 100644 --- a/docs/style-guide-for-guide-articles.md +++ b/docs/style-guide-for-guide-articles.md @@ -17,27 +17,12 @@ The titles use a speacial YAML front matter syntax block as shown below. These c These are the specific front matter requirements: 1. The front matter block should be on the first line of the file. 2. The front matter block should not have whitespaces before and after the lines. -3. Each key value pair is separated by one space only +3. The `title` keyword and the string value after the colon (`:`) must only be separted by a single space. +4. If the article is a translation from the english version, the front matter block should also have a `titleLocale` keyword with appilicable translation for the english title. Here are some examples of properly named titles: -> [`src/pages/html/tables/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/src/pages/html/tables/index.md) - -```markdown ---- -title: Tables ---- -``` - -> [`src/pages/css/borders/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/src/pages/css/borders/index.md) - -```markdown ---- -title: Borders ---- -``` - -> [`src/pages/javascript/loops/for-loop/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/src/pages/javascript/loops/for-loop/index.md) +> [`guide/english/javascript/loops/for-loop/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/guide/english/javascript/loops/for-loop/index.md) ```markdown --- @@ -45,6 +30,15 @@ title: For Loop --- ``` +> [`guide/spanish/algorithms/binary-search-trees/index.md`](https://github.com/freeCodeCamp/freeCodeCamp/blob/master/guide/spanish/algorithms/binary-search-trees/index.md) + +``` +--- +title: Binary Search Trees +localeTitle: Árboles binarios de búsqueda +--- +``` + ## Modularity Each article should explain exactly one concept, and that concept should be apparent from the article's title.