Skip to content

docs(8.1): fix the dead CLA download links and document the CLA in the English guide - #377

Open
qwer381 wants to merge 1 commit into
IvorySQL:v5.6from
qwer381:docs/fix-v5.6-cla-links
Open

qwer381 wants to merge 1 commit into
IvorySQL:v5.6from
qwer381:docs/fix-v5.6-cla-links

Conversation

@qwer381

@qwer381 qwer381 commented Nov 10, 2026 •

Copy link
Copy Markdown

docs(8.1): repair the two dead CLA download links and add a CLA section to the English guide

Closes #376

What

  • CN/modules/ROOT/pages/8.1.adoc: replace the two hashed website asset URLs for the CLA PDFs with the stable paths the site serves today (https://ivorysql.org/pdf/individual_cla.pdf and https://ivorysql.org/pdf/corporate_cla.pdf). The old URLs return 404.
  • EN/modules/ROOT/pages/8.adoc: add a ==== Signing the CLA subsection under Licensing of IvorySQL contributions. The English guide never mentioned the CLA, although it is a hard requirement for review.

2 files changed, 11 insertions(+), 2 deletions(-).

Why

Signing the CLA is mandatory: 8.1.adoc itself says a pull request from a contributor without a signed CLA cannot enter the review process, and IvorySQL/IvorySQL README.md:97 repeats it for code contributions. With the links dead, a new contributor following the Chinese guide cannot even download the document; and a contributor reading the English guide is never told that the step exists.

The replacement URLs are the ones already used by the live page https://ivorysql.org/community/contribution-guidelines — the page the main repository README points at for contribution guidelines — so this aligns the documentation with the website instead of inventing a new location.

The two changed hunks

CN/modules/ROOT/pages/8.1.adoc, lines 103-104:

-* https://www.ivorysql.org/zh-CN/assets/files/individual_cla-a81f001209eb5ce0f8ea7c3be4cc69b5.pdf[个人贡献者]
-* https://www.ivorysql.org/zh-CN/assets/files/corporate_cla-76e89b6f17b0bc102cbc1105d438a917.pdf[企业贡献者]
+* https://ivorysql.org/pdf/individual_cla.pdf[个人贡献者]
+* https://ivorysql.org/pdf/corporate_cla.pdf[企业贡献者]

EN/modules/ROOT/pages/8.adoc: nine lines inserted between ==== Licensing of IvorySQL contributions and === What Contribution Can You Make:

==== Signing the CLA

Before submitting any code or documentation contribution you must sign the Contributor License Agreement (CLA). The CLA is a hard requirement of the IvorySQL community: a pull request from a contributor without a signed CLA on file cannot enter the review process.

* https://ivorysql.org/pdf/individual_cla.pdf[Individual Contributor License Agreement]
* https://ivorysql.org/pdf/corporate_cla.pdf[Corporate Contributor License Agreement]

Download the agreement that applies to you, fill in your full name, e-mail address and GitHub/Gitee/AtomGit account name, sign it by hand, and send the signed PDF to cla@ivorysql.org. Keep a copy for your own records. Contributions are covered from the date of your first submission, so the earlier the CLA is filed the better.

Testing

HTTP status of the four URLs involved (2026-11-10):

301 -> 404  https://www.ivorysql.org/zh-CN/assets/files/individual_cla-a81f001209eb5ce0f8ea7c3be4cc69b5.pdf
301 -> 404  https://www.ivorysql.org/zh-CN/assets/files/corporate_cla-76e89b6f17b0bc102cbc1105d438a917.pdf
200  application/pdf  https://ivorysql.org/pdf/individual_cla.pdf    (162201 bytes)
200  application/pdf  https://ivorysql.org/pdf/corporate_cla.pdf     (166639 bytes)

Local Antora 3.2.2 build (same generator as the repo's pr-preview workflow), before -> after:

CN 8.1.html : links to zh-CN/assets/files = 2 -> 0 ; links to ivorysql.org/pdf/ = 0 -> 2
EN 8.html   : links to ivorysql.org/pdf/ = 0 -> 2 ; <h4 id="_signing_the_cla"> 2.1.3. Signing the CLA present
warnings    : none originating from 8.1.adoc or 8.adoc (pre-existing warnings in 4.6.2.adoc / 6.3.2.adoc / 7.15.adoc unchanged)

The commit is based on v5.6 @ 7c3f4a6 and applies to it with no conflicts; the diffstat is the 2 files changed, 11 insertions(+), 2 deletions(-) quoted above.

Checklist

  • One issue per PR, and the PR body references it
  • Documentation only, no code change
  • CN and EN both updated
  • Verified rendering with the same Antora version the CI uses

…e English guide

The two CLA links in the Chinese contribution guide point at hashed website
asset names that no longer exist: both return HTTP 404. The website now serves
the same documents from https://ivorysql.org/pdf/individual_cla.pdf and
https://ivorysql.org/pdf/corporate_cla.pdf, which is also what the live
contribution-guidelines page links to.

The English contribution guide does not mention the CLA at all, even though an
unsigned contributor's pull request cannot enter review. Add a "Signing the
CLA" subsection under "Licensing of IvorySQL contributions" with both
agreements and the cla@ivorysql.org address.

Documentation only, CN + EN, 2 files.

Closes #<ISSUE_NUMBER>

Signed-off-by: 王诗焱 <3372848903@qq.com>
@github-actions
github-actions Bot temporarily deployed to pull request November 10, 2026 14:03 Inactive
@github-actions

Copy link
Copy Markdown

🚀 IvorySQL-Docs Preview Ready

@qwer381

qwer381 commented Nov 10, 2026

Copy link
Copy Markdown
Author

CLA: the Individual Contributor License Agreement for 王诗焱 (GitHub: qwer381) was signed and emailed to cla@ivorysql.org on 2026-11-10 (delivery confirmed by the mail provider).

If the community needs it re-sent to another address, or needs a scanned wet signature instead of the typed one, say the word and I will send it again.

@github-actions

Copy link
Copy Markdown

🚀 IvorySQL-Docs Preview Ready

@github-actions
github-actions Bot temporarily deployed to pull request November 13, 2026 05:56 Inactive
@github-actions

Copy link
Copy Markdown

🚀 IvorySQL-Docs Preview Ready

This branch was previously deployed

1 inactive deployment
pull request — d87fe879 Deployed Nov 13, 2026 by github-actions[bot]
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.

docs: the CLA download links in 8.1 return 404 and the English guide never mentions the CLA

2 participants