Skip to content

feat: Japanese translation for docs #1855

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

Merged
merged 25 commits into from
Aug 16, 2024

Conversation

yoshi2no
Copy link
Contributor

@yoshi2no yoshi2no commented Aug 15, 2024

Changes

ref: #1815

  • fix: correct link to LICENSE (en, zh)
  • fix: correct link to openapi-fetch, Enable noUncheckedIndexedAccess in TSConfig (en, zh)
  • add vitepress ja config
  • translate openapi-typescript
  • translate openapi-fetch
  • translate openapi-react-query

I believe there shouldn’t be any content missing from the latest documents since I’m referring to the most up-to-date version.

How to Review

  • language code is correct
  • It should redirect to version 6.x of the English documentation when using version 6.x with the Japanese language specified
  • Ensure the "search docs" is working
    • Is there anything I need to do to enable this for the Japanese docs?

Checklist

N/A

@yoshi2no yoshi2no requested a review from a team as a code owner August 15, 2024 12:28
Copy link

changeset-bot bot commented Aug 15, 2024

⚠️ No Changeset found

Latest commit: e2e888a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@yoshi2no yoshi2no marked this pull request as draft August 15, 2024 12:28
@yoshi2no yoshi2no changed the title Feature/docs ja/yoshi2no feat: Japanese translation for docs Aug 15, 2024
@drwpow
Copy link
Contributor

drwpow commented Aug 15, 2024

Thank you so much for opening! Re: search, that’s all automatic! Algolia scans the published site on its own, so there’s nothing to do on our end. Yes there is a slight delay before Japenese docs would appear in search yes but not long (~1 day)

Is it OK if I push an empty commit to
this PR? That’ll create a preview link on Cloudflare Pages to test out

@yoshi2no
Copy link
Contributor Author

@drwpow

ok! yes please!

@@ -7,7 +7,7 @@ description: Quickstart

openapi-typescript turns [OpenAPI 3.0 & 3.1](https://spec.openapis.org/oas/latest.html) schemas into TypeScript quickly using Node.js. No Java/node-gyp/running OpenAPI servers necessary.

The code is [MIT-licensed](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-typescript/LICENSE") and free for use.
The code is [MIT-licensed](https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-typescript/LICENSE) and free for use.
Copy link
Contributor Author

@yoshi2no yoshi2no Aug 15, 2024

Choose a reason for hiding this comment

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

This is the fix for the invalid link mentioned in the Changes same for zh doc.

@yoshi2no yoshi2no marked this pull request as ready for review August 16, 2024 17:19
@drwpow
Copy link
Contributor

drwpow commented Aug 16, 2024

Oh shoot it’s not the developer permissions; it’s that Cloudflare just doesn’t deploy previews for forks at all 🤔. My commit didn’t do anything. I’ve just always assumed.

Anyway, made a docs preview to inspect: https://ja-preview.openapi-ts.pages.dev/

Overall, the dev version is pretty reliable! But just in case others wanted to inspect it easily too. (Also to check Cloudflare didn’t have a build error)

Copy link
Contributor

@drwpow drwpow left a comment

Choose a reason for hiding this comment

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

This looks amazing! Great work with this, thank you! 🙏 Skimming through the pages, they seem good to me (minus me not being able to read Japanese). Docs all seem to be working well.

But let me know when you’re ready to merge this! This looks good from my end. After merge, I’ll trigger a manual reindex from Algolia so that appears in search as soon as possible.

@yoshi2no
Copy link
Contributor Author

@drwpow

Thank you for the review!
After taking another quick look, everything seems good to me as well. Let’s go ahead and merge it! 🚀

@drwpow drwpow merged commit 68b5cb6 into openapi-ts:main Aug 16, 2024
16 checks passed
@siketyan
Copy link

As a native Japanese speaker, thank you and great work @yoshi2no! I took a look the diff and the preview quickly and could not find any issues for now. I would like to review Japanese docs if needed, so feel free to mention me if you are finding a reviewer for that!

@yoshi2no
Copy link
Contributor Author

@siketyan

Thank you for your comment and for taking the time to review! 🙏
I’ll definitely mention you if I need a reviewer in the future!

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.

3 participants