From 7e59d4b13ee7402de1f9c7a6e5a62fd0540f56db Mon Sep 17 00:00:00 2001 From: Ilya Kantor Date: Sun, 14 Apr 2019 17:09:12 +0300 Subject: [PATCH] translate --- AUTHORING.md | 37 +++++++++++++++++++++++++++++++++++++ TRANSLATION.md | 8 +++++--- 2 files changed, 42 insertions(+), 3 deletions(-) create mode 100644 AUTHORING.md diff --git a/AUTHORING.md b/AUTHORING.md new file mode 100644 index 000000000..17516b583 --- /dev/null +++ b/AUTHORING.md @@ -0,0 +1,37 @@ + +# Authoring + +This describes important stuff about authoring new articles of the tutorial. + +## Internal links + +All tutorial links should start from the root, not including the domain. + +✅ OK: + +```md +We'll cover that in the chapter [about functions](/function-basics) +``` + +❌ Not ok: + +```md +We'll cover that in the chapter [about functions](https://javascript.info/function-basics) +``` + +Also, to reference a chapter, there's a special "info:" scheme, like this: + +```md +We'll cover that in the chapter . +``` + +Becomes: +```html +We'll cover that in the chapter Function basics. +``` + +The title is auto-inserted from the referenced article. That has the benefit of keeping the right title if the article gets renamed. + +## TODO + +Ask @iliakan to for more details. diff --git a/TRANSLATION.md b/TRANSLATION.md index a885886ad..0c7be4648 100644 --- a/TRANSLATION.md +++ b/TRANSLATION.md @@ -62,7 +62,7 @@ documento.querySelector('.hola').interiorHTML = texto; ## External Links -If an external link is to Wikipedia, e.g. , and a version of that article exists in your language that is of decent quality, consider linking to that version instead. +If an external link is to Wikipedia, e.g. https://en.wikipedia.org/wiki/JavaScript, and a version of that article exists in your language that is of decent quality, consider linking to that version instead. Example: @@ -70,10 +70,12 @@ Example: [JavaScript](https://en.wikipedia.org/wiki/JavaScript) is a programming language. ``` -✅ OK: +✅ OK (en -> es): ```md [JavaScript](https://es.wikipedia.org/wiki/JavaScript) es un lenguaje de programación. ``` -For links that have no equivalent, just use the English link. +For links to MDN, that are only partially translated, also use the language-specific version. + +If a linked article has no translated version, leave the link "as is".