Skip to content

[KYUUBI #7434][DOC] Reformat client docs from RST to Markdown - #7696

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

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

Conversation

@dnskr

@dnskr dnskr commented Aug 30, 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 empty pages:
    • docs/client/advanced/configurations.rst
    • docs/client/advanced/features/engine_resources.rst
    • docs/client/advanced/features/engine_share_level.rst
    • docs/client/advanced/features/engine_ttl.rst
    • docs/client/advanced/features/engine_type.rst
    • docs/client/advanced/features/scala.rst
    • docs/client/advanced/logging.rst
  • Simplifies Client Commons menu: remove features directory and move Plan Only Execution Mode page up.
  • Increases myst_heading_anchors to 4 to fix the following warning:
    ./docs/client/rest/rest_api.md:281: WARNING: 'myst' cross-reference target not found: 'kyuubioperationevent' [myst.xref_missing]
    
  • Rename Configure Kerberos for clients to Access Kerberized Kyuubi to Kerberos Configuration and remove the page from Security / Authentication index page.
  • Fixed cross-references.

The 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

Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
@dnskr dnskr added this to the v1.13.0 milestone Aug 30, 2026
@dnskr dnskr self-assigned this Aug 30, 2026
@github-actions github-actions Bot added the kind:documentation Documentation is a feature! label Aug 30, 2026
Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
@dnskr
dnskr force-pushed the rst-to-md-client-pages branch from e6b83d2 to 1a4745c Compare August 30, 2026 20:59
@dnskr dnskr closed this in 8606354 Aug 31, 2026
dnskr added a commit that referenced this pull request Aug 31, 2026
### 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 empty pages:
   - docs/client/advanced/configurations.rst
   - docs/client/advanced/features/engine_resources.rst
   - docs/client/advanced/features/engine_share_level.rst
   - docs/client/advanced/features/engine_ttl.rst
   - docs/client/advanced/features/engine_type.rst
   - docs/client/advanced/features/scala.rst
   - docs/client/advanced/logging.rst
- Simplifies `Client Commons` menu: remove `features` directory and move `Plan Only Execution Mode` page up.
- Increases `myst_heading_anchors` to 4 to fix the following warning:
  ```
  ./docs/client/rest/rest_api.md:281: WARNING: 'myst' cross-reference target not found: 'kyuubioperationevent' [myst.xref_missing]
  ```
- Rename  `Configure Kerberos for clients to Access Kerberized Kyuubi` to `Kerberos Configuration` and remove the page from `Security / Authentication ` index page.
- Fixed cross-references.

The 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

Closes #7696 from dnskr/rst-to-md-client-pages.

Closes #7434

1a4745c [Denis Krivenko] [DOC] Reformat quick start docs from RST to Markdown
575b2aa [Denis Krivenko] [DOC] Reformat client docs from RST to Markdown

Authored-by: Denis Krivenko <dnskrv88@gmail.com>
Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
(cherry picked from commit 8606354)
Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
@dnskr

dnskr commented Aug 31, 2026

Copy link
Copy Markdown
Contributor Author

Thank you for the review!

Merged to master and branch-1.12.

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