Skip to content

update contribution guides#289

Open
jiaoshuntian wants to merge 10 commits into
IvorySQL:masterfrom
jiaoshuntian:master
Open

update contribution guides#289
jiaoshuntian wants to merge 10 commits into
IvorySQL:masterfrom
jiaoshuntian:master

Conversation

@jiaoshuntian

Copy link
Copy Markdown
Contributor

update contribution guides

- 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.
@github-actions
github-actions Bot temporarily deployed to pull request July 20, 2026 05:57 Inactive
@github-actions

Copy link
Copy Markdown

🚀 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
@github-actions

Copy link
Copy Markdown

🚀 IvorySQL-Docs Preview Ready

@github-actions
github-actions Bot temporarily deployed to pull request July 20, 2026 06:17 Inactive
@github-actions

Copy link
Copy Markdown

🚀 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
@github-actions
github-actions Bot temporarily deployed to pull request July 20, 2026 06:34 Inactive
@github-actions

Copy link
Copy Markdown

🚀 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.
@github-actions
github-actions Bot temporarily deployed to pull request July 20, 2026 07:05 Inactive
@github-actions

Copy link
Copy Markdown

🚀 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.
@github-actions
github-actions Bot temporarily deployed to pull request July 20, 2026 07:24 Inactive
@github-actions

Copy link
Copy Markdown

🚀 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.
@github-actions
github-actions Bot temporarily deployed to pull request July 20, 2026 07:48 Inactive
@github-actions

Copy link
Copy Markdown

🚀 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.
@github-actions

Copy link
Copy Markdown

🚀 IvorySQL-Docs Preview Ready

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.

1 participant