From 0a027ca2a5efa1e9e4921bc4da1b34eced415e05 Mon Sep 17 00:00:00 2001 From: Y Matsuda <25644062+sidemt@users.noreply.github.com> Date: Sat, 22 Oct 2022 16:21:33 +0900 Subject: [PATCH] docs(i18n): add list of translatable footer links (#48180) docs: add list of translatable footer links --- docs/language-lead-handbook.md | 72 ++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/docs/language-lead-handbook.md b/docs/language-lead-handbook.md index c840a29ad9e..4d05fa1411a 100644 --- a/docs/language-lead-handbook.md +++ b/docs/language-lead-handbook.md @@ -104,6 +104,78 @@ You can convert from one format to the other carefully changing it manually. Or > [!TIP] > A new workflow is being worked on, there will be only one place to change in the future. +## How to translate articles in the footer links + +There are some links listed at the bottom of the footer (About, Alumni Network, Open Source etc.) and some of them can be translated into your language in the same way as other articles. + +Articles that can be translated: + +- About +- Support +- Academic Honesty +- Code of Conduct + +The following articles should **not** be translated: + +- Shop +- Sponsors +- Privacy Policy +- Terms of Service +- Copyright Policy + +The following links are pointing to external sites and cannot be translated: + +- Alumni Network +- Open Source + +### Change the footer links in the news + +Once you have translated and published the articles listed as "can be translated" above, you can update the links in the footer for `/news` by editing the file at `news/config/i18n/locales//links.json` in the [freeCodeCamp/news](https://github.com/freeCodeCamp/news) repository. + +> [!NOTE] +> Pull requests to this repository are currently limited to staff only. If you want to update this file, ask someone on the staff team for help. + +Update the following part in the file: + +```json +{ + ... + "footer": { + "about": "https://www.freecodecamp.org/news/about/", + "support": "https://www.freecodecamp.org/news/support/", + "honesty": "https://www.freecodecamp.org/news/academic-honesty-policy/", + "coc": "https://www.freecodecamp.org/news/code-of-conduct/" + } +} +``` + +### Change the footer links in the curriculum + +When you have translated and published the articles listed as "can be translated" above, as well as when the curriculum in your language is ready for launch, you can update the links in the footer for `/learn` by editing the file at `client/i18n/locales//links.json` in the [freeCodeCamp/freeCodeCamp](https://github.com/freeCodeCamp/freeCodeCamp) repository. + +> [!WARNING] +> Only "About", "Support", "Academic Honesty", and "Code of Conduct" can be translated. Leave other URLs unchanged. + +Update the following part in the file: + +```json +{ + ... + "footer": { + "about-url": "https://www.freecodecamp.org/news/about/", + "shop-url": "https://www.freecodecamp.org/shop/", + "support-url": "https://www.freecodecamp.org/news/support/", + "sponsors-url": "https://www.freecodecamp.org/news/sponsors/", + "honesty-url": "https://www.freecodecamp.org/news/academic-honesty-policy/", + "coc-url": "https://www.freecodecamp.org/news/code-of-conduct/", + "privacy-url": "https://www.freecodecamp.org/news/privacy-policy/", + "tos-url": "https://www.freecodecamp.org/news/terms-of-service/", + "copyright-url": "https://www.freecodecamp.org/news/copyright-policy/" + }, + ... +} +``` + ## How to translate the info boxes headers in the documentation You can find these boxes all around the documentation: