Skip to content

Conversation

johtani
Copy link

@johtani johtani commented Sep 24, 2025

What's being changed:

This PR is the first version of Japanese translation docs.

  • Japanese translated documentation files under i18n/ja/docusaurus-plugin-content-docs/current
  • Locale selector in docusaurus.config.js
  • Use @site in docs/weaviate/best-practices/index.md for fixing build error in i18n
  • A GitHub Actions workflow for translation automation (translate_docs.yaml)

About Japanese translated documents

The Japanese translation files were created following the official Docusaurus i18n procedure.
To ensure that images and other assets from the English documentation are available in the Japanese version, the following steps were performed:

  • mkdir -p i18n/ja/docusaurus-plugin-content-docs/current
  • cp -r docs/** i18n/ja/docusaurus-plugin-content-docs/current

After copying, the necessary files were translated using the translate_docs.py script.

About translate_docs github actions workflow

This GitHub Actions workflow (translate_docs.yaml) automatically processes changes in the docs directory. When files in docs directory are updated or when the workflow is manually triggered, it:

  1. Detects which files in docs directory have changed.
  2. Runs a Python script (tools/translate_docs.py) to translate or process those files.
  3. This script translates .md and .mdx files only. Other added files are copied to i18n directory. And also deleted files are removed from i18n directory.
  4. Commits any resulting changes to a new branch with current commit hash in main branch.
  5. Automatically creates a pull request with the updates.

IMPORTANT

The tools/translate_docs.py uses OpenAI API for translation, so you have to set theOPENAI_API_KEY to the secrets in this repository settings.

When building with the translated files, many warnings are output.
Unfortunately, build errors also occasionally occur with the translated files (for example, sometimes extra closing HTML tags are inserted).
To address this, we create a branch with the commit hash from the time the translation files were generated and then open a pull request from it.

Type of change:

  • Documentation content updates (non-breaking change to fix/update documentation )

How has this been tested?

  • Local build - the site works as expected when running yarn start

And tests github actions workflow in my forked repository.

Copy link

@orca-security-eu orca-security-eu bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Warning SAST high 2   medium 32   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca
🛡️ The following SAST misconfigurations have been detected
NAME FILE
medium Direct Response Write from User Input May Lead to XSS Vulnerability ...ippets/20_backend.js View in code
medium Direct Response Write from User Input May Lead to XSS Vulnerability ...pets/30_fullstack.js View in code
medium Missing timeout in requests module can cause DoS ...ts/102_collection.py View in code
medium Missing timeout in requests module can cause DoS ...ts/102_collection.py View in code
medium Missing timeout in requests module can cause DoS ...pets/103_searches.py View in code
medium Missing timeout in requests module can cause DoS ...ppets/104_usecase.py View in code
medium Missing timeout in requests module can cause DoS ...hods.1.fixed.size.py View in code
medium Missing timeout in requests module can cause DoS ...s.2.variable.size.py View in code
medium Missing timeout in requests module can cause DoS ...s.2.variable.size.py View in code
medium Missing timeout in requests module can cause DoS ....3.mixed.strategy.py View in code
medium Missing timeout in requests module can cause DoS ...ippets/30_example.py View in code
medium Missing timeout in requests module can cause DoS ...ippets/30_example.py View in code
medium Missing timeout in requests module can cause DoS ...ts/102_collection.py View in code
medium Missing timeout in requests module can cause DoS ...ts/102_collection.py View in code
medium Missing timeout in requests module can cause DoS ...ts/102_collection.py View in code
medium Missing timeout in requests module can cause DoS ...ts/102_collection.py View in code
medium Missing timeout in requests module can cause DoS ...pets/103_searches.py View in code
medium Missing timeout in requests module can cause DoS ..._snippets/104_rag.py View in code
medium Missing timeout in requests module can cause DoS ...ts/102_collection.py View in code
medium Missing timeout in requests module can cause DoS ..._import_example_1.py View in code
medium Missing timeout in requests module can cause DoS ..._import_example_1.py View in code
medium Missing timeout in requests module can cause DoS ...ovider.generative.py View in code
medium Missing timeout in requests module can cause DoS ...ovider.generative.py View in code
medium Missing timeout in requests module can cause DoS ...ovider.generative.py View in code
medium Missing timeout in requests module can cause DoS ...ovider.generative.py View in code
... ... ... ...

Note: The scan should have failed if no policies were configured in warn-only mode.

@weaviate-git-bot
Copy link

To avoid any confusion in the future about your contribution to Weaviate, we work with a Contributor License Agreement. If you agree, you can simply add a comment to this PR that you agree with the CLA so that we can merge.

beep boop - the Weaviate bot 👋🤖

PS:
Are you already a member of the Weaviate Forum?

@johtani
Copy link
Author

johtani commented Sep 24, 2025

I agree with the CLA. :)

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