[KYUUBI #7434] [DOC] Reformat quick_start pages from reStructuredText to Markdown#7541
Draft
dnskr wants to merge 1 commit into
Draft
[KYUUBI #7434] [DOC] Reformat quick_start pages from reStructuredText to Markdown#7541dnskr wants to merge 1 commit into
dnskr wants to merge 1 commit into
Conversation
Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
dnskr
commented
Jul 3, 2026
Comment on lines
+25
to
+27
| --- | ||
| maxdepth: 2 | ||
| --- |
Contributor
Author
There was a problem hiding this comment.
Directive properties are rendered as text in standard markdown editors (viewers), see index.md
| "sphinx.ext.mathjax", | ||
| "myst_parser", | ||
| "sphinx_copybutton", | ||
| "sphinx_markdown_tables", |
Contributor
Author
There was a problem hiding this comment.
Need to be deleted to fix substitution in markdown tables.
|
|
||
| ```{parsed-literal} | ||
| $ tar zxf apache-kyuubi-{{ release }}-bin.tgz | ||
| ``` |
Contributor
Author
There was a problem hiding this comment.
Substitution doesn't work in standard markdown editors (viewers), see quick_start.md
| ```shell | ||
| bin/kyuubi run | ||
| ``` | ||
| ::: |
Contributor
Author
There was a problem hiding this comment.
Directive uses ::: delimiters instead of ``` to render shell code correctly.
However, in standard markdown editors (viewers) it looks as poorly formatted text.
Comment on lines
+27
to
+33
| ```{parsed-literal} | ||
| <dependency> | ||
| <groupId>org.apache.kyuubi</groupId> | ||
| <artifactId>kyuubi-hive-jdbc-shaded</artifactId> | ||
| <version>{{ release }}</version> | ||
| </dependency> | ||
| ``` |
Contributor
Author
There was a problem hiding this comment.
I've tried different approaches, but substitution doesn't work for xml in this case.
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why are the changes needed?
The changes are needed to test the Markdown format for the documentation.
Related issue: 📝 Consolidate a documentation format to a single approach #7434.
How was this patch tested?
Built the documentation with the following command and verified pages:
Was this patch authored or co-authored using generative AI tooling?
Assisted-by: Junie