From: Jinjiang Date: Fri, 21 Apr 2023 09:23:37 +0000 (+0800) Subject: chore: add the guide for self-host translations [skip ci](#1788) X-Git-Tag: v4.2.0~15 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dcafc02fe20cda13874d5236dc75101dbf0c7aa4;p=thirdparty%2Fvuejs%2Frouter.git chore: add the guide for self-host translations [skip ci](#1788) Co-authored-by: Eduardo San Martin Morote --- diff --git a/.github/contributing.md b/.github/contributing.md index 89a1ccd1..f48225ce 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -117,6 +117,10 @@ Currently, all the docs can be found in `packages/docs`. It contains the English Besides that, the `.vitepress` sub-folder is used to put the config and theme, including the i18n information. +Consider the following two options in order to contribute to the translations: + +### Translate in a `` sub-folder and host it on our official repo + If you want to start translating the docs in a new language: 1. Create the corresponding `` sub-folder for your translation. @@ -139,6 +143,17 @@ If you want to maintain a existing translation: For more real examples, please check out [all the PRs with title "docs(zh): sync" after 2023-01-01](https://github.com/vuejs/router/pulls?q=is%3Apr+created%3A%3E2023-01-01+docs%28zh%29+sync). +### Self-host the translation + +You can also host the translation on your own. To create one, just simply fork our GitHub repo and change the content and site config in `packages/docs`. To long-term maintain it, we _highly recommend_ a similar way that we do above for our officially hosted translations: + +1. Ensure you create a _checkpoint branch_ (for example, a branch named sync). This branch should always align with the commit of the original documentation that corresponds to your most recent translation. +2. Utilize the diff result between the latest official repository and your own by using the git diff command or the GitHub Compare page to guide your translation. +3. Complete the translation process. +4. Update the _checkpoint branch_ accordingly. + + + ## Credits Thank you to all the people who have already contributed to Vue Router!