Skip to content

[KYUUBI #7434][DOC] Reformat connector docs from RST to Markdown - #7744

Open
dnskr wants to merge 2 commits into
apache:masterfrom
dnskr:rst-to-md-connector-pages
Open

dnskr wants to merge 2 commits into
apache:masterfrom
dnskr:rst-to-md-connector-pages

Conversation

@dnskr

@dnskr dnskr commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Why are the changes needed?

The changes are needed to unify the format used for documentation, as described in the issue #7434.

The PR does not change page contents (only very minimal adjustments) to ensure an easier review of the migration.

The pages contain out-of-date information and broken links, requiring a comprehensive review and updates in a separate PRs.

How was this patch tested?

Tested by building the documentation and comparing the pages against the live site.

Was this patch assisted by generative AI tooling?

Assisted-by: Qwen Coder

Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
@github-actions github-actions Bot added the kind:documentation Documentation is a feature! label Sep 14, 2026

@wangzhigang1999 wangzhigang1999 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Non-blocking; otherwise looks good. Built the documentation locally and checked the rendered pages.

Comment thread docs/connector/spark/tpch.md Outdated

1. kyuubi-spark-sql-engine-{{ release }}_2.12.jar, the engine jar deployed with a Kyuubi distribution
2. A copy of Spark distribution
3. `kyuubi-spark-connector-tpch-<release>_2.12.jar`, which can be found in the [Maven Central](https://repo1.maven.org/maven2/org/apache/kyuubi/kyuubi-spark-connector-tpch_2.12/)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we preserve {{ release }} here and in the spark.jars example below, as in tpcds.md? The 1.12.0 documentation renders the matching version in both places. Keeping the substitution would preserve this behavior after the format migration.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, thanks!

I've fixed it:

Screenshot 2026-09-20 at 20 11 14

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, we should use kyuubi-spark-sql-engine_2.12-1.13.0-SNAPSHOT.jar instead of kyuubi-spark-sql-engine-1.13.0-SNAPSHOT_2.12.jar. There are similar issues elsewhere in the doc, should we update them all together? Note: the PMC changed this once before, see: c3edb02

Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:documentation Documentation is a feature!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants