]> git.ipfire.org Git - thirdparty/vuejs/router.git/commitdiff
chore: add the guide for self-host translations [skip ci](#1788)
authorJinjiang <zhaojinjiang@me.com>
Fri, 21 Apr 2023 09:23:37 +0000 (17:23 +0800)
committerGitHub <noreply@github.com>
Fri, 21 Apr 2023 09:23:37 +0000 (11:23 +0200)
Co-authored-by: Eduardo San Martin Morote <posva@users.noreply.github.com>
.github/contributing.md

index 89a1ccd11e418614e212d6f8c8bdde6f2f038d55..f48225cedfbd93836fa2bd873aff957d3ef95f43 100644 (file)
@@ -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 `<lang>` 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 `<lang>` 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.
+
+<!-- TODO: add an example once we have got one -->
+
 ## Credits
 
 Thank you to all the people who have already contributed to Vue Router!