update contribution guides - #289
Merged
Merged
Conversation
- Add Chinese and English ecosystem component adaptation contribution guides (ecosystem_contribution_guide.adoc) - Place under IvorySQL Developers > contribution directory - Update Chinese and English nav.adoc to add navigation entries
Merge community_contribution_guide.adoc and ecosystem_contribution_guide.adoc into a single contribution_guide.adoc for both Chinese and English versions. Changes: - Create unified contribution_guide.adoc combining all contribution content - Remove separate community and ecosystem contribution guide files - Update navigation in both CN and EN nav.adoc files - Content covers: community workflow, roles, getting started, code contributions, and ecosystem component adaptation This consolidation provides a single entry point for all contribution-related information, eliminating content duplication and improving user experience.
|
🚀 IvorySQL-Docs Preview Ready
|
Incentive policy content is maintained on the official website (www.ivorysql.org/contribution-guidelines). Replace the duplicated section with a link to avoid content redundancy. - Remove '激励政策' section from Chinese version - Remove 'Incentive Policy' section from English version - Add links pointing to official website for incentive details
Completely remove incentive policy content from contribution guides as it is maintained on the official website only. - Remove link reference from Chinese version - Remove link reference from English version
|
🚀 IvorySQL-Docs Preview Ready
|
|
🚀 IvorySQL-Docs Preview Ready
|
These sections will be displayed on the official website only. The documentation site contribution guide now focuses on: - Roles and responsibilities - Getting started (GitHub account, CLA) - Code contributions - Ecosystem component adaptation - Remove '贡献方式' section from Chinese version - Remove '社区协作流程' section from Chinese version - Remove 'Ways to Contribute' section from English version - Remove 'Community Collaboration Process' section from English version
|
🚀 IvorySQL-Docs Preview Ready
|
Consolidate contribution documentation by renaming issue_submission_guide.adoc to contribution_guide.adoc and merging content from the previous contribution_guide.adoc. Changes: - Rename issue_submission_guide.adoc to contribution_guide.adoc (CN) - Merge roles and responsibilities section from previous contribution_guide - Merge getting started section (GitHub account, CLA signing) - Add ecosystem component adaptation entry in contribution types - Add complete ecosystem component adaptation section with detailed steps - Remove duplicate contribution_guide.adoc (EN) as it will be recreated separately This creates a unified contribution guide that serves as the single entry point for all contribution-related documentation in the docs site, while the www site maintains overview and conceptual content.
|
🚀 IvorySQL-Docs Preview Ready
|
Fixed several problematic links in the Chinese contribution guide: - Line 43: Changed self-referencing xref to internal anchor reference - Line 294: Fixed malformed link in section title - Lines 336, 347: Removed malformed placeholder links with $user variables All links now point to valid targets or have been simplified to plain text where appropriate.
|
🚀 IvorySQL-Docs Preview Ready
|
- Line 43: Changed xref link to plain text '提交 Issue' - Lines 112-113: Updated CLA file URLs to new addresses - Line 160: Changed xref link to plain text '生态组件适配' - Line 164: Removed GitHub URL - Line 166: Added AtomGit URL (https://atomgit.com/IvorySQL/IvorySQL) - Line 167: Removed 码云 URL - Line 181: Changed email to proper mailto link - Line 915: Fixed source repository URL format - Lines 924, 946: Changed internal references to plain text - Line 1097: Changed internal reference to plain text - Line 1144: Changed xref link to plain text '签署 CLA' All problematic links have been fixed or converted to plain text where appropriate.
|
🚀 IvorySQL-Docs Preview Ready
|
Convert all internal section references with '章节' suffix to plain text format: - Line 43: '提交 Issue'章节 → 提交 Issue - Line 160: '生态组件适配'章节 → 生态组件适配 - Line 1145: '签署 CLA'章节 → 签署 CLA All section references are now in plain text format without quotes or '章节' suffix.
|
🚀 IvorySQL-Docs Preview Ready
|
Major reorganization of the contribution guide: - Rename contribution sections: 代码贡献, 文档贡献, 组件贡献 - Remove 提交blog and 网站贡献指南 sections (merged into 文档贡献) - Merge 网站贡献指南 content into 文档贡献 section - Add two contribution methods to 文档贡献: quick web edit and full Git workflow - Add preview URL explanation after PR submission - Remove 第二步：环境准备 from 组件贡献 section - Rename steps from Chinese numerals to Arabic numerals for consistency - Remove step numbering prefixes (第1步, 第2步, etc.) from headings - Change compatibility label to extension label - Simplify 第4步 title from 编辑文档或修改代码 to 修改代码 - Add document center structure explanation to 文档贡献
|
🚀 IvorySQL-Docs Preview Ready
|
|
🚀 IvorySQL-Docs Preview Ready
|
Replace '更新 small 内容' with '更新少量内容' to maintain consistent Chinese language usage throughout the document.
|
🚀 IvorySQL-Docs Preview Ready
|
Translate the complete Chinese contribution guide to English, including: - Overview, Code of Conduct, and Governance sections - Roles and Responsibilities (Users, Contributors, Maintainers) - Getting Started (GitHub account registration, CLA signing) - Submit Issue and Submit PR common processes - Code Contribution workflow - Documentation Contribution (website quick edit and full Git workflow) - Component Adaptation Contribution (detailed 4-step process) - FAQ section The English version maintains the same structure and content as the Chinese version, providing bilingual support for the IvorySQL community.
|
🚀 IvorySQL-Docs Preview Ready
|
Rewrite the '管理说明' section with more natural and professional Chinese phrasing: - Use clearer structure with separate paragraphs for team organization and career progression - Replace awkward direct translations with idiomatic Chinese expressions - Change '团队荣誉' to '团队担当' (Team Stewardship) for better meaning - Change '责任' to '责任担当' (Accountability) for emphasis - Improve overall readability and flow while maintaining all original content
Update the English Governance section to match the improved Chinese translation: - Restructure into clear paragraphs for team organization and career progression - Use consistent terminology: 'Team Stewardship' and 'Accountability' - Improve clarity and readability while maintaining all original content - Ensure both language versions convey the same meaning with natural phrasing
|
🚀 IvorySQL-Docs Preview Ready
|
|
🚀 IvorySQL-Docs Preview Ready
|
Convert indented bold text to proper AsciiDoc bulleted list format for:
- Chinese: 团队担当 and 责任担当
- English: Team Stewardship and Accountability
Changed from incorrect indented format:
*Team Stewardship*: description
To correct AsciiDoc bulleted list format:
* *Team Stewardship*: description
This ensures proper rendering in the generated HTML documentation.
|
🚀 IvorySQL-Docs Preview Ready
|
Chinese version: - Change '赞赏' to '欣赏' for more natural expression - Remove '和领导者' to simplify the welcome message English version: - Remove 'and leaders' to match Chinese version simplification These changes make the welcome message more concise and natural in both language versions.
|
🚀 IvorySQL-Docs Preview Ready
|
…orkflow Add a new '认领 Issue' (Claim an Issue) section to the '通用贡献流程' (Common Contribution Process) chapter that describes the general process applicable to all contribution types: - Browse Issue list and search for relevant Issues - Confirm Issue is not already assigned - Claim unassigned Issues using 'Assign yourself' - Create new Issues when needed - Wait for maintainer confirmation before starting work Simplify the '认领或新建 Issue' (Claim or Create Issue) section in the '组件适配贡献' (Component Adaptation Contribution) chapter to reference the general process and only keep component-specific requirements: - Issue type: Feature Request - Label: extension - Title format: Ecosystem Integration: <component name> - Body format: one sentence describing the component and its purpose This reduces content duplication and makes the general Issue claiming process clearer for all types of contributions.
|
🚀 IvorySQL-Docs Preview Ready
|
Reorder the three common contribution process sections to follow a logical flow: 1. Submit Issue - first step to report bugs or request features 2. Claim an Issue - second step to claim an existing issue or create a new one 3. Submit PR - third step to submit code changes Update the introductory sentence to reflect all three steps: - Chinese: '认领 Issue、提交 Issue 和提交 PR 是所有类型贡献的公共流程。无论您参与哪种类型的贡献，都需要遵循这三个步骤。' - English: 'Claiming an Issue, submitting an Issue, and submitting a PR are common processes for all types of contributions. Regardless of which type of contribution you participate in, you need to follow these three steps.'
|
🚀 IvorySQL-Docs Preview Ready
|
Update the introductory sentence to match the actual section order: - Chinese: '提交 Issue、认领 Issue 和提交 PR...' - English: 'Submitting an Issue, claiming an Issue, and submitting a PR...' This ensures consistency between the introduction and the section layout.
|
🚀 IvorySQL-Docs Preview Ready
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
update contribution guides