Skip to content

Commit dcafc02

Browse files
Jinjiangposva
andauthored
chore: add the guide for self-host translations [skip ci](#1788)
Co-authored-by: Eduardo San Martin Morote <[email protected]>
1 parent bbd80ad commit dcafc02

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

.github/contributing.md

+15
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,10 @@ Currently, all the docs can be found in `packages/docs`. It contains the English
117117

118118
Besides that, the `.vitepress` sub-folder is used to put the config and theme, including the i18n information.
119119

120+
Consider the following two options in order to contribute to the translations:
121+
122+
### Translate in a `<lang>` sub-folder and host it on our official repo
123+
120124
If you want to start translating the docs in a new language:
121125

122126
1. Create the corresponding `<lang>` sub-folder for your translation.
@@ -139,6 +143,17 @@ If you want to maintain a existing translation:
139143

140144
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).
141145

146+
### Self-host the translation
147+
148+
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:
149+
150+
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.
151+
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.
152+
3. Complete the translation process.
153+
4. Update the _checkpoint branch_ accordingly.
154+
155+
<!-- TODO: add an example once we have got one -->
156+
142157
## Credits
143158

144159
Thank you to all the people who have already contributed to Vue Router!

0 commit comments

Comments
 (0)