Add bilingual documentation support with English as default language#1321
Add bilingual documentation support with English as default language#1321
Conversation
Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
mkdocs.yml, 使得文档网站同时支持中英文。默认英文| @@ -0,0 +1,37 @@ | |||
| { | |||
There was a problem hiding this comment.
the assets adn images folders can shared for all language documentation
There was a problem hiding this comment.
You're absolutely right! I've optimized the documentation structure by removing the duplicated assets and images folders from each language directory and updated all references to use the shared folders instead. This reduces storage space and eliminates the need to maintain multiple copies of the same assets. (commit 1fc9783)
… across languages Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
|
the files in |
…icsearch readers Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
…e, SQLServer, JSON, Excel) Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
…ongoDB) and database writers (MySQL, PostgreSQL, ElasticSearch) Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
You're absolutely right! I'm systematically translating all reader and writer documentation files. Progress so far: 18/31 readers and 4/35 writers completed. Currently working through the remaining files including HDFS, FTP, S3, Stream, Data readers and all remaining writers. All documents will be translated to provide complete English documentation. (commit cd87ca0) |
…S3, Stream, Data, RDBMS) Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
…ndra, ClickHouse, TxtFile writers Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
…A, InfluxDB, TDengine, Kudu, HBase variants, Hive) Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
…, SQLServer, Sybase, Databend, RDBMS, HANA, TDengine) Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
… data, file, and data lake writers Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
|
the plugin |
…s Material native approach Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
Fixed the multi-language support by removing the |
|
give the comprehensive guide to build the English and Chinese document |
…tion Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
I've created a comprehensive documentation build guide with complete instructions for building both English and Chinese documentation. The guide includes: 📖 Complete Build Guide (
🛠️ Build Automation:
🚀 Quick Commands: # Test all builds
./test-docs.sh
# Build all documentation
./build-docs.sh
# Serve for development
mkdocs serve --config-file mkdocs-en.yml # English
mkdocs serve --config-file mkdocs-zh.yml # ChineseThe guide covers everything from basic setup to advanced multi-language deployment strategies. (commit c93b993) |
|
after running |
…al serving Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
Fixed the issue by creating development-specific configurations. The problem was that Solution: Use the new development configurations: # For English development - serves at root level
mkdocs serve --config-file mkdocs-en-dev.yml
# Visit: http://localhost:8000/ (not /latest)
# For Chinese development - serves at root level
mkdocs serve --config-file mkdocs-zh-dev.yml
# Visit: http://localhost:8000/ (not /latest)The development configs remove versioning complexity and serve content directly at |
|
you should use the single setup file |
Fixed! I've successfully implemented the single setup file approach. Now using only one ✅ Single Configuration: Removed all separate config files ( Commands work as expected:
The single |
Co-authored-by: wgzhao <1001616+wgzhao@users.noreply.github.com>
This PR implements bilingual documentation support for the Addax project, making the documentation accessible to both Chinese and international users with English as the default language.
Changes Made
🌐 Internationalization Setup
mkdocs-static-i18nplugin for bilingual documentation supportzh) to English (en) as requested📁 Documentation Structure
docs/en/- English documentation (default)docs/zh/- Chinese documentation (existing content preserved)mkdocs.ymlwith proper i18n configuration and navigation translations📝 English Translations
Created comprehensive English translations for core documentation:
index.md,quickstart.md,setupJob.md,commandline.mddebug.md,encrypt_password.md,statsreport.mdmysqlreader.md,postgresqlreader.md,txtfilereader.md🎯 Key Features
/en/,/zh/)Technical Implementation
Navigation Structure
Benefits
Testing
This implementation addresses the requirement to "将项目 docs 目录下的文档翻译成英文。修改
mkdocs.yml, 使得文档网站同时支持中英文。默认英文" by providing a robust bilingual documentation system with English as the default language.💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.