-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: non-checkpoint-branch workflow #1855
Conversation
✅ Deploy Preview for vue-router canceled.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #1855 +/- ##
=======================================
Coverage 90.77% 90.77%
=======================================
Files 24 24
Lines 1116 1116
Branches 348 348
=======================================
Hits 1013 1013
Misses 63 63
Partials 40 40 ☔ View full report in Codecov by Sentry. |
130e1e6
to
e285522
Compare
@posva This is ready for review. Thanks. |
@Jinjiang Thanks! Really sorry for the delay, I will give it a look in 1-2 weeks |
@Jinjiang I really liked the idea, I hope it goes ahead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot @Jinjiang and sorry again for the delay 🙏
.github/contributing.md
Outdated
1. See what translation you need to do to sync up with the original docs. There are 2 popular ways: | ||
1. Via the GitHub Compare page: https://github.com/vuejs/router/compare/ (only see the changes in `packages/docs/*`) from the checkpoint hash to `main` branch. You can find the checkpoint hash for your language via the translation status file `packages/docs/.vitepress/translation-status.json`. | ||
2. Via a local command: `pnpm run docs:compare-to-translate <lang> [<commit>]`. | ||
2. Create your own branch and start the translation update, following the previous comparison. | ||
3. Same to step 4 and step 5 in the “starting a new language” workflow. Once you have done all above, create a pull request and then wait for the maintainers to approve and merge it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a few issues with this section:
- no introductory sentence. It's as if the 1st point was that but I think it's missing something along the lines of Keeping translations updated
- inconsistent spacing (3 and 4, should be 2 spaces)
- The sample URL should be a real example so users can actually replace things in that URL to test it out
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@posva for spacing, I found 2 spaces in front of ordered list won't be recognized as indents in the Markdown preview. So I kept 4 spaces instead. The 3 spaces was a mistake, sorry about that (however they can also be recognized as indents).
For the rest part I modified a little accordingly. Please take a further look. Thanks.
.github/contributing.md
Outdated
1. Via the GitHub Compare page: https://github.com/vuejs/router/compare/ (only see the changes in `packages/docs/*`) from the checkpoint hash to `main` branch. You can find the checkpoint hash for your language via the translation status file `packages/docs/.vitepress/translation-status.json`. | ||
2. Via a local command: `pnpm run docs:compare-to-translate <lang> [<commit>]`. | ||
2. Create your own branch and start the translation update, following the previous comparison. | ||
3. Same to step 4 and step 5 in the “starting a new language” workflow. Once you have done all above, create a pull request and then wait for the maintainers to approve and merge it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's better to explicitly add the steps 4 and 5 with adapted commands
@posva hey, do you think we can merge this or there is anything further to improve? :-) |
Co-authored-by: Eduardo San Martin Morote <[email protected]>
a33d15f
to
23bab9a
Compare
@nazarepiedady now this workflow has been officially confirmed. feel free to translate the vue router docs in this way. 😉 I will also write something about this in the vuejs-translations org later. Thanks. |
@Jinjiang, I will start making the necessary changes to organize the work I am doing over the Portuguese translation to match the current conclusions about how the translation workflow should be. |
An update to follow this workflow demo:
https://github.com/Jinjiang/translation-workflow-demo
This is considered an alternative approach to #1824
Changes:
translation-status.json
to record translation checkpoints. This script should be run when each time we sync up translations for any language.Thanks.