-
Notifications
You must be signed in to change notification settings - Fork 12
Add Japanese docs and github actions workflow for translation #187
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
base: main
Are you sure you want to change the base?
Conversation
…tutorials, and quickstart
There was a problem hiding this 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 | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| SAST | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
🛡️ The following SAST misconfigurations have been detected
| NAME | FILE | ||
|---|---|---|---|
| Direct Response Write from User Input May Lead to XSS Vulnerability | ...ippets/20_backend.js | View in code | |
| Direct Response Write from User Input May Lead to XSS Vulnerability | ...pets/30_fullstack.js | View in code | |
| Missing timeout in requests module can cause DoS | ...ts/102_collection.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ts/102_collection.py | View in code | |
| Missing timeout in requests module can cause DoS | ...pets/103_searches.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ppets/104_usecase.py | View in code | |
| Missing timeout in requests module can cause DoS | ...hods.1.fixed.size.py | View in code | |
| Missing timeout in requests module can cause DoS | ...s.2.variable.size.py | View in code | |
| Missing timeout in requests module can cause DoS | ...s.2.variable.size.py | View in code | |
| Missing timeout in requests module can cause DoS | ....3.mixed.strategy.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ippets/30_example.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ippets/30_example.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ts/102_collection.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ts/102_collection.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ts/102_collection.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ts/102_collection.py | View in code | |
| Missing timeout in requests module can cause DoS | ...pets/103_searches.py | View in code | |
| Missing timeout in requests module can cause DoS | ..._snippets/104_rag.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ts/102_collection.py | View in code | |
| Missing timeout in requests module can cause DoS | ..._import_example_1.py | View in code | |
| Missing timeout in requests module can cause DoS | ..._import_example_1.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ovider.generative.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ovider.generative.py | View in code | |
| Missing timeout in requests module can cause DoS | ...ovider.generative.py | View in code | |
| 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.
|
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. |
|
I agree with the CLA. :) |
What's being changed:
This PR is the first version of Japanese translation docs.
i18n/ja/docusaurus-plugin-content-docs/currentdocusaurus.config.js@siteindocs/weaviate/best-practices/index.mdfor fixing build error in i18ntranslate_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/currentcp -r docs/** i18n/ja/docusaurus-plugin-content-docs/currentAfter 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
docsdirectory are updated or when the workflow is manually triggered, it:docsdirectory have changed.tools/translate_docs.py) to translate or process those files..mdand.mdxfiles only. Other added files are copied toi18ndirectory. And also deleted files are removed fromi18ndirectory.IMPORTANT
The
tools/translate_docs.pyuses OpenAI API for translation, so you have to set theOPENAI_API_KEYto 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:
How has this been tested?
yarn startAnd tests github actions workflow in my forked repository.