Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/client/bi_tools/datagrip.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please go to [Download DataGrip](https://www.jetbrains.com/datagrip/download) to

### Get Kyuubi Started

[Get kyuubi server started](../../quick_start/quick_start.rst) before you try DataGrip with kyuubi.
[Get kyuubi server started](../../quick_start/quick_start.md) before you try DataGrip with kyuubi.

For debugging purpose, you can use `tail -f` or `tailf` to track the server log.

Expand Down
2 changes: 1 addition & 1 deletion docs/client/bi_tools/hue.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

### Get Kyuubi Started

[Get the server Started](../../quick_start/quick_start.rst) first before your try Hue with Kyuubi.
[Get the server Started](../../quick_start/quick_start.md) first before your try Hue with Kyuubi.

```
Welcome to
Expand Down
4 changes: 2 additions & 2 deletions docs/client/jdbc/hive_jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
Kyuubi is fully compatible with Hive JDBC and ODBC drivers that let you connect to popular Business Intelligence (BI)
tools to query, analyze and visualize data though Spark SQL engines.

It's recommended to use [Kyuubi JDBC driver](./kyuubi_jdbc.rst) for new applications.
It's recommended to use [Kyuubi JDBC driver](./kyuubi_jdbc.md) for new applications.

## Install Hive JDBC

Expand Down Expand Up @@ -53,7 +53,7 @@ libraryDependencies += "org.apache.hive" % "hive-jdbc" % "2.3.8"
implementation group: 'org.apache.hive', name: 'hive-jdbc', version: '2.3.8'
```

For BI tools, please refer to [Quick Start](../../quick_start/index.rst) to check the guide for the BI tool used.
For BI tools, please refer to [Quick Start](../../quick_start/index.md) to check the guide for the BI tool used.
If you find there is no specific document for the BI tool that you are using, don't worry, the configuration part for all BI tools are basically the same.
Also, we will appreciate if you can help us to improve the document.

Expand Down
9 changes: 8 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,18 @@
"sphinx.ext.mathjax",
"myst_parser",
"sphinx_copybutton",
"sphinx_markdown_tables",
"sphinx_togglebutton",
"notfound.extension",
"sphinxemoji.sphinxemoji",
]
myst_enable_extensions = [
"colon_fence",
"substitution"
]

myst_substitutions = {
"release": release
}

master_doc = "index"

Expand Down
32 changes: 32 additions & 0 deletions docs/quick_start/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-->

# Quick Start

```{note}
In this section, you will learn how to setup and interact with kyuubi quickly.
```

```{toctree}
---
maxdepth: 2
---
quick_start
quick_start_with_helm
quick_start_with_jdbc
quick_start_with_data_agent
```
29 changes: 0 additions & 29 deletions docs/quick_start/index.rst

This file was deleted.

Loading
Loading