[KYUUBI #7434][DOC] Reformat quick start docs from RST to Markdown - #7666
[KYUUBI #7434][DOC] Reformat quick start docs from RST to Markdown#7666dnskr wants to merge 1 commit into
Conversation
| <dependency> | ||
| <groupId>org.apache.kyuubi</groupId> | ||
| <artifactId>kyuubi-hive-jdbc-shaded</artifactId> | ||
| <version>${kyuubi.version}</version> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
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>
Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
277a3c2 to
de46d28
Compare
pan3793
left a comment
There was a problem hiding this comment.
the current state is good enough to go. and we can re-evalute parsed-literal once the patched version is available.
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. 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 ``` Assisted-by: Qwen Coder Closes #7666 from dnskr/rst-to-md-quick-start-pages. Closes #7434 de46d28 [Denis Krivenko] [DOC] Reformat quick start docs from RST to Markdown Authored-by: Denis Krivenko <dnskrv88@gmail.com> Signed-off-by: Denis Krivenko <dnskrv88@gmail.com> (cherry picked from commit 804c002) Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
|
Thank you for the review! Merged to |
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:
sphinx_markdown_tablesextension to fix variable substitution in tables.quick_startpages.building kyuubilink.There is a slight difference between the configuration table representation on the
Getting Startedpage and the Maven dependency declaration on theGetting Started with Hive JDBCpage 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:
Was this patch assisted by generative AI tooling?
Assisted-by: Qwen Coder