From 8e8d64b2f436d571f52076978ccef8b894412905 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Criado-P=C3=A9rez?= Date: Thu, 24 Mar 2022 16:49:19 +0100 Subject: [PATCH] contributing --- src/common/navigation.yaml | 2 +- src/pages/en/contributing.md | 2 ++ src/pages/en/contributing/translations.md | 23 +++++++++++++++++++++++ 3 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 src/pages/en/contributing/translations.md diff --git a/src/common/navigation.yaml b/src/common/navigation.yaml index 1aa48f05..c3290b14 100644 --- a/src/common/navigation.yaml +++ b/src/common/navigation.yaml @@ -97,4 +97,4 @@ sections: - path: /bns-contract - path: /stacking-contract - - path: /contributing + - path: /contributing \ No newline at end of file diff --git a/src/pages/en/contributing.md b/src/pages/en/contributing.md index 2b56d514..434b1e10 100644 --- a/src/pages/en/contributing.md +++ b/src/pages/en/contributing.md @@ -12,6 +12,8 @@ images: Welcome. Thank you for your interest in contributing and helping make these docs as good as they can be. This page will outline how this site is built, its general structure, getting it running locally, and some helpful tips for using all of its features. +These steps should only be followed to make changes on the general structure of the site and documents written in English. To make changes on pages in other languages, please refer to translations instead. This means that in the folder /src/pages/ you should any make changes in /src/pages/en, as changes in any other locale (/src/pages/es or /src/pages/fr for example) will be overwritten. + ## Next.js, MDX, Markdown This docs site is built with [Next.js](https://github.com/vercel/next.js) and uses something called [MDX](https://mdxjs.com/). diff --git a/src/pages/en/contributing/translations.md b/src/pages/en/contributing/translations.md new file mode 100644 index 00000000..995bff20 --- /dev/null +++ b/src/pages/en/contributing/translations.md @@ -0,0 +1,23 @@ +--- +title: How to contribute with translations +description: Want to help tranlating these docs to your local language?. +icon: BlockstackIcon +images: + large: /images/contribute.svg + sm: /images/contribute.svg +--- + +## Help with translations + +Translations are managed with Crowin. +Anybody can colaborate and no technichal skills are required, as it's all done on the browser. + +To help with translation please go to [this page](https://crowdin.com/project/docsstacksco), click and language and start translating. + +All help is appreciated. + +Note to Github users: Please don't add any translations via our GitHub repository, as the translated pages get rewritten from Crowin, so you must use this tool instead. + +## Adding a language + +Want to add a new language that doesn't show in Crowin? Great! Let us know, and we will add it.