Skip to content
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

About the synchronization of each translated version with the English version #48

Closed
C-BJ opened this issue Aug 17, 2022 · 5 comments
Closed
Labels
documentation Improvements or additions to documentation

Comments

@C-BJ
Copy link
Member

C-BJ commented Aug 17, 2022

This problem needs to be solved very much, otherwise it will create a very confusing situation

Here are my ideas:
1.Each translated version requires 100% coverage (means that the PR for adding a new language should translate all the documents at once)
2.In the process of adding a new language, changes to the content of the English version must be alerted in adding-new-language PR(Finally, translation contributors are asked to carefully review the content of the translation, to prevent it from not tracking the full process of translation in PR)
3.All new content should be added to the English version first
4.Changes to the English version of the content need to be made via PR, and all language translations for the new content must be completed before the PR can be merged

@mtshiba

@mtshiba
Copy link
Member

mtshiba commented Aug 17, 2022

I found this.

https://gist.github.com/FujiHaruka/f7b54f4602735d8e6674c0b1ce1df93c

This is an article in Japanese, the content is to provide a badge to indicate if the document is up-to-date.

I will try this.

@mtshiba
Copy link
Member

mtshiba commented Aug 17, 2022

It is probably difficult to update all language versions at the same time, and it would be appropriate to have someone who notices do the updating. With this badge, it is easy to tell at a glance that a document is out of date.

@mtshiba
Copy link
Member

mtshiba commented Aug 17, 2022

I succeeded.

Let me show you a real example.

The simplified Chinese document is up-to-date.

スクリーンショット 2022-08-18 011122

Make changes to the English version of README.md (remove spaces).

スクリーンショット 2022-08-18 011354

So, the Chinese version is out-of-date.

スクリーンショット 2022-08-18 012109

Those who find out-of-date will look at the diff of the latest file (English version) and rewrite the contents of out-of-date file.

Since the content of the Chinese version does not need to be updated, simply rewrites the hash value to the latest English version.

Look at the History of the latest version (English) of the file and click on the top.

(If you edit the English version and another language version at the same time, commit the English version first to get the hash value.)

スクリーンショット 2022-08-18 014150

Then you can see the hash value of the commit.

スクリーンショット 2022-08-18 013827

Rewrite the hash value of the file (Chinese version) with updated contents.
Note that two rewrites are required.

スクリーンショット 2022-08-18 012620

After commit_hash%3D and after commit_hash=.

[![badge](https://...commit_hash%3D47b9b758acea9d4ea5d618436935b197636074f6)
](https://...commit_hash=47b9b758acea9d4ea5d618436935b197636074f6)

Again, it is up-to-date.

スクリーンショット 2022-08-18 012947

To those updating badges:
Once the document is updated, a badge will say "inaccessible," but this is not a problem as it will soon return to normal.

@mtshiba mtshiba added the documentation Improvements or additions to documentation label Aug 17, 2022
@C-BJ
Copy link
Member Author

C-BJ commented Aug 18, 2022

great work @mtshiba

@mtshiba mtshiba closed this as completed Aug 18, 2022
@mtshiba
Copy link
Member

mtshiba commented Aug 18, 2022

I will open an another issue to put this badge on all translated documents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants