Skip to content

Add Japanese translation of the Mbed TLS Migration Guide - #291

Open
kojiws wants to merge 1 commit into
wolfSSL:masterfrom
kojiws:add_japanese_of_mbedtls_migration
Open

kojiws wants to merge 1 commit into
wolfSSL:masterfrom
kojiws:add_japanese_of_mbedtls_migration

Conversation

@kojiws

@kojiws kojiws commented Oct 29, 2026

Copy link
Copy Markdown
Contributor

Description

Adds a Japanese version of the Mbed TLS to wolfSSL Migration Guide, following the same layout as the other localized manuals.

The translation is based on the English guide as of commit 26562f4 ("Add Mbed TLS to wolfSSL migration guide", #288).

Changes

  • MbedTLS-Migration/src-ja/: Japanese translation of chapters 1-10
  • MbedTLS-Migration/mkdocs-ja.yml: MkDocs config for the Japanese HTML (language: ja, translated nav titles)
  • MbedTLS-Migration/Makefile: output MbedTLS-wolfSSL-Migration-Guide-jp.pdf when DOC_LANG=JA

Translation notes

  • Code samples are unchanged except that their comments are translated.
  • All API names, macros, configure options and error codes match the English source.
  • Chapter 10 (Support) adds the Japanese contact (info@wolfssl.jp, wolfssl.jp), as the other Japanese manuals do.
  • Chapter 10 links the wolfSSL Manual to its Japanese edition. The other related guides keep their English URLs and are marked (英語), meaning "English".
  • The PDF title page still uses the shared English header.txt, the same as the other Japanese guides.

Testing

Built both outputs with make DOC_LANG=JA in MbedTLS-Migration/, inside the Dockerfile builder image:

  • PDF (24 pages): checked that the TOC, headings, body text, code blocks and the API mapping tables render with the CJK font, and that no table overflows the page.
  • HTML: checked the Japanese nav and page titles, and that every cross-chapter link resolves to chapterNN.html.

Copilot AI balanced review requested due to automatic review settings October 29, 2026 12:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are reported for the Japanese migration guide and its HTML/PDF configuration.

No open issues 🎉

What changed in this PR

Adds a Japanese edition of the Mbed TLS to wolfSSL Migration Guide, following the repository’s localized-manual structure and supporting Japanese HTML and PDF output.

Changes:

  • Translates all 10 chapters, including migration examples, API mappings, and configuration guidance.
  • Adds Japanese MkDocs navigation and a language-specific PDF filename.
  • Includes Japanese support contacts and links to the Japanese wolfSSL manual.
File Description
MbedTLS-Migration/​src-ja/​chapter10.md Localizes support resources and adds Japanese contacts.
MbedTLS-Migration/​src-ja/​chapter09.md Translates configuration-option mappings.
MbedTLS-Migration/​src-ja/​chapter08.md Translates API mappings and usage notes.
MbedTLS-Migration/​src-ja/​chapter07.md Translates getting-started and interoperability guidance.
MbedTLS-Migration/​src-ja/​chapter06.md Translates additional wolfSSL feature descriptions.
MbedTLS-Migration/​src-ja/​chapter05.md Translates hardware and platform integration guidance.
MbedTLS-Migration/​src-ja/​chapter04.md Translates common migration pitfalls.
MbedTLS-Migration/​src-ja/​chapter03.md Localizes TLS client examples and explanatory text.
MbedTLS-Migration/​src-ja/​chapter02.md Translates design, memory, and licensing comparisons.
MbedTLS-Migration/​src-ja/​chapter01.md Translates scope, support status, and migration workflow.
MbedTLS-Migration/​mkdocs-ja.yml Configures Japanese HTML navigation and theme language.
MbedTLS-Migration/​Makefile Selects the -jp.pdf filename when DOC_LANG=JA.

Review effort: Balanced

@kojiws kojiws self-assigned this Oct 30, 2026
@kojiws
kojiws force-pushed the add_japanese_of_mbedtls_migration branch from 036970d to 3295151 Compare October 30, 2026 06:29
@kojiws
kojiws force-pushed the add_japanese_of_mbedtls_migration branch from 3295151 to dc8ed4f Compare October 30, 2026 06:41
@kojiws kojiws removed their assignment Oct 30, 2026
@kojiws
kojiws requested a review from yosuke-wolfssl October 30, 2026 07:09
@yosuke-wolfssl yosuke-wolfssl self-assigned this Oct 30, 2026

@yosuke-wolfssl yosuke-wolfssl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'll send my findings to you directly.

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