Skip to content

[KYUUBI #7434][DOC] Reformat quick start docs from RST to Markdown - #7666

Open
dnskr wants to merge 1 commit into
apache:masterfrom
dnskr:rst-to-md-quick-start-pages
Open

[KYUUBI #7434][DOC] Reformat quick start docs from RST to Markdown#7666
dnskr wants to merge 1 commit into
apache:masterfrom
dnskr:rst-to-md-quick-start-pages

Conversation

@dnskr

@dnskr dnskr commented Aug 26, 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 also:

  • Removes sphinx_markdown_tables extension to fix variable substitution in tables.
  • Fixes cross-references to quick_start pages.
  • Fixes building kyuubi link.

There is a slight difference between the configuration table representation on the Getting Started page and the Maven dependency declaration on the Getting Started with Hive JDBC page because variable substitution doesn't work inside code blocks, but it shouldn't affect user experience.

This PR does not change page contents to ensure an easier review of the migration.

How was this patch tested?

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

make clean html


open https://kyuubi.readthedocs.io/en/master/quick_start/index.html
open _build/html/quick_start/index.html

open https://kyuubi.readthedocs.io/en/master/quick_start/quick_start.html
open _build/html/quick_start/quick_start.html

open https://kyuubi.readthedocs.io/en/master/quick_start/quick_start_with_jdbc.html
open _build/html/quick_start/quick_start_with_jdbc.html

Was this patch assisted by generative AI tooling?

Assisted-by: Qwen Coder

@dnskr dnskr added this to the v1.13.0 milestone Aug 26, 2026
@github-actions github-actions Bot added the kind:documentation Documentation is a feature! label Aug 26, 2026
@dnskr dnskr self-assigned this Aug 26, 2026
<dependency>
<groupId>org.apache.kyuubi</groupId>
<artifactId>kyuubi-hive-jdbc-shaded</artifactId>
<version>${kyuubi.version}</version>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

variable substitution doesn't work inside code blocks

maybe we can ask AI to write a simple extension or pre-process it with a python function to make it work? but the current approach is also fine.

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.

I researched this while trying to make it work, and from what I understand, there's a design reason why substitutions don't work inside code blocks in Sphinx and MyST parser.
One solution is to substitute the entire code block, but that adds logic to conf.py and makes the Markdown file less friendly to read.
For now, I'm leaning toward avoiding the release value in code blocks when possible, in favor of something more general like this workaround. But I'll continue working on format migration, and I'll try to find more elegant solution.

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.

A quick update regarding the issue.

I've used parsed-literal code-block to render the following code and it works as intended:

$ tar zxf apache-kyuubi-{{ release }}-bin.tgz
image

However, in the current MyST implementation parsed-literal directive removes leading and trailing spaces (PR executablebooks/MyST-Parser#1176 available), and doesn't work properly with XML content, so the discussed code does not rendered correctly:

<dependency>
    <groupId>org.apache.kyuubi</groupId>
    <artifactId>kyuubi-hive-jdbc-shaded</artifactId>
    <version>{{ release }}</version>
</dependency>
image

Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
@dnskr
dnskr force-pushed the rst-to-md-quick-start-pages branch from 277a3c2 to de46d28 Compare August 30, 2026 19:06
@dnskr dnskr changed the title [DOC] Reformat quick start docs from RST to Markdown [KYUUBI #7434][DOC] Reformat quick start docs from RST to Markdown Aug 30, 2026
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.

2 participants