yzeng1618 opened a new pull request, #10109:
URL: https://github.com/apache/seatunnel/pull/10109
### Purpose of this pull request
This pull request aims to complete and improve the Chinese documentation for
SeaTunnel connectors and formats.
**Background**: During a review of the SeaTunnel official website, we
discovered that the Chinese and English documentation for JDBC connectors were
identical, indicating that Chinese translations were missing or incomplete.
This prompted a comprehensive audit of the documentation structure.
**Scope**:
- Identified and translated 3 missing Chinese documentation files in the
connector-v2 module
- Added comprehensive Chinese translations for 37 connector documentation
files (source, sink, and format connectors)
- Added Chinese documentation for command and start-v2 modules
- Ensured all 291 documentation files (across command, start-v2,
connector-v2, and transform-v2 modules) now have complete English and Chinese
versions
**Quality Improvements**:
- Followed established translation guidelines: translate descriptions and
explanations while preserving configuration keys, code examples, and technical
syntax
- Maintained consistency with existing Chinese documentation format
(referenced HiveJdbc.md as the standard)
- Performed individual file-by-file translation instead of global parameter
replacement to ensure accuracy
- All translations maintain technical accuracy and terminology consistency
### Does this PR introduce _any_ user-facing change?
Yes. This PR introduces user-facing changes by providing complete Chinese
documentation for SeaTunnel connectors and formats.
**Previous behavior**:
- Chinese documentation was incomplete or missing for many connectors
- Users viewing the Chinese version of the documentation site would see
English content or incomplete translations
- Example: JDBC connector documentation was identical in both Chinese and
English versions
**Changes this PR proposes**:
- Complete Chinese translations for all connector documentation files
- Proper localization of titles, descriptions, and explanatory text
- Consistent terminology and formatting across all Chinese documentation
- Users can now access fully translated documentation in their preferred
language
This improves the user experience for Chinese-speaking users and increases
the accessibility of SeaTunnel documentation.
### How was this patch tested?
Documentation changes were validated through:
1. **Completeness Check**: Verified that all English documentation files
have corresponding Chinese versions
- Scanned all modules: command, start-v2, connector-v2, transform-v2
- Confirmed 291 total documentation files with complete English-Chinese
pairs
2. **Format Validation**: Ensured all Chinese documentation follows the
established format standards
- Reviewed against reference files (HiveJdbc.md, Mysql.md, canal-json.md)
- Verified proper MDX imports, section headings, and code block
preservation
3. **Translation Quality**: Spot-checked translations for accuracy and
consistency
- Verified configuration keys and code examples remain unchanged
- Confirmed technical terminology is properly translated
- Ensured no global parameter replacement was performed
4. **Files Created/Modified**:
- Created 3 missing files: maxwell-json.md, Greenplum.md, InfluxDB.md
- Created 37 connector documentation translations
- Created command and start-v2 module documentation
### Check list
* [x] Documentation files updated to describe the new/improved features
* [x] All Chinese documentation files follow the established format
guidelines
* [x] Configuration keys and code examples are preserved in all translations
* [x] Terminology is consistent with existing Chinese documentation
* [x] No breaking changes introduced - this is purely documentation
improvement
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
