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

Initialize the Japanese Localization Guidelines #259

Merged

Conversation

Okabe-Junya
Copy link
Contributor

@Okabe-Junya Okabe-Junya commented Jun 15, 2024

ref. #153
Deploy preview: link

Feature Description

  • Initialize the Japanese Localization Guidelines
    • for new contributors and many members

The Japanese Localization Guidelines include the following contents:

  • Style Guide
  • How to write specific terms in Japanese
  • List of projects with ongoing Japanese localization, and the leads and l10n reviewers for each project
  • Communication methods

Background

#153 (comment)

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 Okabe-Junya force-pushed the feat/initialize-japanese-l10n-guide branch from 2d79ef8 to 99f6627 Compare June 15, 2024 16:00
@Okabe-Junya
Copy link
Contributor Author

Okabe-Junya commented Jun 15, 2024

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

@Okabe-Junya Okabe-Junya force-pushed the feat/initialize-japanese-l10n-guide branch from b145bbd to 115d298 Compare June 15, 2024 16:31
@nate-double-u
Copy link
Member

nate-double-u commented Jun 17, 2024

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 and others added 6 commits June 18, 2024 03:28
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
@Okabe-Junya Okabe-Junya force-pushed the feat/initialize-japanese-l10n-guide branch from bdb1d37 to bb84976 Compare June 17, 2024 18:28
@Okabe-Junya
Copy link
Contributor Author

Okabe-Junya commented Jun 17, 2024

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.

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
Copy link
Member

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
Copy link
Member

nate-double-u commented Jun 17, 2024

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
Copy link
Contributor Author

Okabe-Junya commented Jun 17, 2024

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
Copy link
Member

nate-double-u commented Jun 17, 2024

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)

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
@Okabe-Junya
Copy link
Contributor Author

I’ve disabled prettier for Japanese README, e2e6bf1

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

@chalin
Copy link
Collaborator

chalin commented Jun 25, 2024

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
Copy link
Contributor Author

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
Copy link
Collaborator

chalin commented Jun 25, 2024

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:

Copy link

@naonishijima naonishijima left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link

@hhiroshell hhiroshell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your hard work!

@ymotongpoo
Copy link

LGTM

@kenta-iijima
Copy link

LGTM

@katzchang
Copy link

LGTM👍

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Okabe-Junya. See inline comments.

docs/localization/README.md Outdated Show resolved Hide resolved
.prettierignore Outdated Show resolved Hide resolved
docs/localization/ja/README.md Show resolved Hide resolved
docs/localization/ja/README.md Outdated Show resolved Hide resolved
docs/localization/ja/README.md Show resolved Hide resolved
Okabe-Junya and others added 3 commits June 28, 2024 17:36
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
@Okabe-Junya Okabe-Junya requested a review from chalin June 28, 2024 09:30
@Okabe-Junya
Copy link
Contributor Author

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!

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you for the updates.

@Okabe-Junya
Copy link
Contributor Author

Thank you for your support, chalin!

Copy link
Member

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Okabe-Junya, and everyone on the Japanese localization team. Great work here!

@nate-double-u nate-double-u merged commit 75cc9b0 into cncf:main Jul 2, 2024
5 checks passed
@Okabe-Junya Okabe-Junya deleted the feat/initialize-japanese-l10n-guide branch July 2, 2024 01:38
Dindihub pushed a commit to Dindihub/TUF-docs-analysis that referenced this pull request Aug 10, 2024
* feat: initialize Japanese l10n guide

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* update: add review section

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* fix: anchor link

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* Update: l10n reviewer

Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* fix: linter errors

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* feat: add ## Localization READMEs

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* fix: link checker error

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* update: .prettierignore

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* Update docs/localization/README.md

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>

* Update .prettierignore

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>

* fix: L6

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

---------

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
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.

9 participants