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

docs: Add Japanese docs. #507

Closed
wants to merge 96 commits into from
Closed

Conversation

coji
Copy link
Contributor

@coji coji commented Mar 3, 2024

Add the Japanese version of the documentation to docs/ja.

I really want to be able to switch between the two in the conform.guide. However, it's quite complicated, so I'm going to add just the md file so that it can be viewed on github.

I wrote the commit comment in detail in Japanese, so it would be good if you could squash merge it.

coji added 30 commits February 29, 2024 09:03
チュートリアルの翻訳
一部コード上のコメントの翻訳漏れ対応 ホワイトスペースズレを修正
validate.md: Addressing translation omissions
complex-structures.md translated to Japanese.
intent-button.md translated to Japanese.
accessibility.md translated to Japanese.
checkbox-and-radio-group.md translated to Japanese.
@edmundhung
Copy link
Owner

Hi @coji, really appreciate your effort on translating all the docs!

I am a little concern about keeping the translated docs up-to-dated with the english one going forward. I am happy to merge your PR as is, but I am just wondering if it would be a better idea if I should provide a link to your translated copy instead if you have keep it somewhere else. What do you think?

@coji
Copy link
Contributor Author

coji commented Mar 17, 2024

@edmundhung Thanks for your feedback. I agree that maintaining the Japanese documentation separately might be a better approach. I will fork the repository and prepare a page for the Japanese version while keeping it up to date. Once everything is set up, I will reach out to you again to discuss further.

@coji coji closed this Mar 18, 2024
@edmundhung
Copy link
Owner

Thanks @coji :) Feel free to DM me on twitter if you need anything from my side.

Also, I found this link you shared on twitter. Is this the right place to link to for the Japanese translation? 🙌🏼

@coji
Copy link
Contributor Author

coji commented Mar 20, 2024

@edmundhung Thank you for your support.

The site I shared on Twitter was manually created, making it difficult to update, so it would be better not to use that link.

For future updates, I have translated the content of the guide directory into Japanese and included the Japanese md files in a fork of this repository. I've prepared a site on Cloudflare Pages based on the content of the forked repository.

I believe linking to https://conform-guide-jp.pages.dev/ would be best.

The forked repository/branch is as follows. I plan to update it as needed in the future.
https://github.com/coji/conform/tree/feat/guide-in-ja-JP

@coji
Copy link
Contributor Author

coji commented Mar 20, 2024

@edmundhung

Would it be possible to use a CNAME like ja.conform.guide instead? What do you think?

Unfortunately, it seems that Chrome might often recognize https://conform-guide-jp.pages.dev/ as a phishing site. It displayed a warning like the one in the attached image on my machine.

CleanShot 2024-03-20 at 21 44 36@2x

@edmundhung
Copy link
Owner

I don't think I could point the domain to your cloudflare account because of the way Cloudflare pages is configure through its custom proxy.

As an alternative, how about pushing all the translations to a branch called jp in the official repo? In this case, Cloudflare Pages will autoamtically publish it to https://jp.conform.pages.dev and I can even add an alias to make it https://jp.conform.guide. Once I figure out the permission setting, I can also give you dedicate access to push to the JP branch directly if you are willing to help maintaining the translation :)

@coji
Copy link
Contributor Author

coji commented Mar 22, 2024

@edmundhung Thank you for the alternative suggestion. Creating a separate branch in the official repository and pushing the translations there sounds like an excellent idea.

If I may suggest, using ja instead of jp for the branch name would be more appropriate, as it aligns with the ISO language code for Japanese.

It's really convenient that Cloudflare Pages will automatically publish the content to https://ja.conform.pages.dev. Moreover, adding an alias like https://ja.conform.guide would make it even more user-friendly and accessible for Japanese users.

Regarding the maintenance of the translations, I'd be more than happy to help. If you can provide me with direct push access to the ja branch, I can keep the Japanese documentation up to date whenever there are updates to the English version.

This approach allows us to provide the Japanese documentation without modifying the main repository, which seems ideal. I appreciate your willingness to handle the permission settings and any other necessary arrangements.

I'm excited to contribute to the community by helping maintain the translations. Please let me know if there's anything else I can assist with.

Thank you once again for the collaboration and support!

@edmundhung
Copy link
Owner

Sounds good to me. Should I reopen this PR and merge it into the ja branch or if you would like to create a new PR?

@coji
Copy link
Contributor Author

coji commented Mar 24, 2024

@edmundhung.

I've created a new PR for the ja branch target here. Please review.
#536

@coji coji mentioned this pull request Mar 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants