search

cncf / techdocs

CNCF TechDocs Team
https://www.cncf.io
Apache License 2.0
37 stars 26 forks source link

Initialize the Japanese Localization Guidelines #259

Open Okabe-Junya opened 2 weeks ago

Okabe-Junya commented 2 weeks ago

ref. #153 Deploy preview: link

Feature Description

The Japanese Localization Guidelines include the following contents:

Background

https://github.com/cncf/techdocs/issues/153#issuecomment-2123992860

Our project started with the cncf/glossary, and now we are working on l10n for other TAGs and WGs (for example, tag-runtime#145, tag-app-delivery#521). Through this, we have realized the importance of more general l10n documentation (and we think this issue is the best place to discuss it! Thank you @/nate-double-u ).

Okabe-Junya commented 2 weeks ago

To move forward this PR, I would like to do the following:

  1. Accept reviews from Japanese localization reviewers for about a week (until 2024-06-23 00:00 UTC)
  2. Review and merge by reviewers / maintainers from cncf/techdocs
nate-double-u commented 1 week ago

Thanks so much for this!

Could you update this PR to add a section to the CNCF Localization Guides page (/docs/localization/README.md) to introduce these language-specific guides?

I think it would be good to have an English version of this as well (even if it's very rough or just an outline). I'd like to use this work as a template or starting point for other languages. I can't read Japanese, but I assume that there is a process being laid out here that could be generalized.

Okabe-Junya commented 1 week ago

Thank you, @nate-double-u!!

Could you update this PR to add a section to the CNCF Localization Guides page (/docs/localization/README.md) to introduce these language-specific guides?

Ok!! I added ## Localization READMEs section, https://github.com/cncf/techdocs/pull/259/commits/bb84976125b46934604070bf0be76448f275bcee.

I think it would be good to have an English version of this as well (even if it's very rough or just an outline)

SGTM!! Now, I create localization README template and will open another PR - IMO, it would be better to create another PR. Thank you :)

nate-double-u commented 1 week ago

Thank you, @nate-double-u!!

😊

Could you update this PR to add a section to the CNCF Localization Guides page (/docs/localization/README.md) to introduce these language-specific guides?

Ok!! I added ## Localization READMEs section, bb84976.

Perfect, thanks!

I think it would be good to have an English version of this as well (even if it's very rough or just an outline)

SGTM!! Now, I created localization template and will open another PR - IMO, it would be better to create another PR. Thank you :)

That's a good idea, it is a separate (related) thing, and should be in a separate PR—good call.

nate-double-u commented 1 week ago

I think that running npm run fix:format locally will fix the format/link checks.

This doesn't have to happen yet—we've still got time before the Japanese localization reviews are in.

Okabe-Junya commented 1 week ago

Thank you :)

I think that running npm run fix:format locally will fix the format/link checks.

TBH, prettier does not work well for Japanese, since prettier breaks line after a certain number of characters (Please note that Japanese doesn't break lines except "。" (like .))

So, I want to disable linter (at least the Japanese README)

nate-double-u commented 1 week ago

That's fair—I think you can disable things per folder. @chalin to confirm as the lead on the reformatting project (note, they are away this week)

Okabe-Junya commented 1 week ago

I’ve disabled prettier for Japanese README, https://github.com/cncf/techdocs/pull/259/commits/e2e6bf10fbda711801d0e6fceb5e3f0f0fe2695a

(I'll revert it if there are any issues.)

chalin commented 5 days ago

Hi all. Thank you for this initiative @Okabe-Junya. I was away. I'm back but still catching up. I'll get to this as soon as I can. In the meantime, let me cc a few extra people for feedback:

Okabe-Junya commented 5 days ago

Thank you, I appreciate your support, chalin!

I have already informed katzchang, ymotongpoo about this PR. (I announced this PR on the #glossary-localization-japanese channel in CNCF Slack, and they are there!)

Once we receive feedback from a-mccarthy, we can move forward! Thank you :)

chalin commented 5 days ago

Thank you for the clarifications @Okabe-Junya.

In addition to @a-mccarthy's feedback, I would appreciate if the following could formally approve this PR:

ymotongpoo commented 5 days ago

LGTM

kenta-iijima commented 5 days ago

LGTM

katzchang commented 5 days ago

LGTM👍

Okabe-Junya commented 2 days ago

Thank you for the wonderful review, @chalin. Your feedback is very thorough and helpful!

Based on your comments, I have made some revisions. I have also replied to some of your comments (to discuss)

Thanks!