Skip to content

Commit

Permalink
[KYUUBI #1269] Online documentation section in the readme is outdated
Browse files Browse the repository at this point in the history
<!--
Thanks for sending a pull request!

Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
  1. If you add a feature, you can talk about the use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->
Closes #1269

### _How was this patch tested?_
docs only

Closes #1270 from ulysses-you/kyuubi#1269.

Closes #1269

1cb99ef [ulysses-you] address comment
7a597e6 [ulysses-you] address comment
4b15c2c [ulysses-you] Online documentation section in the readme is outdated

Authored-by: ulysses-you <[email protected]>
Signed-off-by: ulysses-you <[email protected]>
  • Loading branch information
ulysses-you committed Oct 22, 2021
1 parent 0653dad commit 936a532
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 19 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
[![codecov](https://codecov.io/gh/apache/incubator-kyuubi/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/incubator-kyuubi)
[![Travis](https://api.travis-ci.com/apache/incubator-kyuubi.svg?branch=master)](https://travis-ci.com/apache/incubator-kyuubi)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/apache/incubator-kyuubi/Kyuubi/master?style=plastic)
[![Documentation Status](https://readthedocs.org/projects/kyuubi/badge/?version=latest)](https://kyuubi.apache.org/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/kyuubi/badge/?version=latest)](https://kyuubi.apache.org/docs/latest/)

## What is Kyuubi?

Expand Down Expand Up @@ -93,29 +93,24 @@ The figure below shows our vision for the Kyuubi Ecosystem. Some of them have be

## Online Documentation

Since Kyuubi 1.0.0, the Kyuubi online documentation is hosted by [https://readthedocs.org/](https://readthedocs.org/).
Since Kyuubi 1.3.0-incubating, the Kyuubi online documentation is hosted by [https://kyuubi.apache.org/](https://kyuubi.apache.org/docs/latest/).
You can find the specific version of Kyuubi documentation as listed below.

- [master/latest](https://kyuubi.readthedocs.io/en/latest/)
- [stable](https://kyuubi.readthedocs.io/en/stable/)
- [v1.1.0](https://kyuubi.readthedocs.io/en/v1.1.0/)
- [v1.0.3](https://kyuubi.readthedocs.io/en/v1.0.3/)
- [v1.0.2](https://kyuubi.readthedocs.io/en/v1.0.2/)
- [v1.0.1](https://kyuubi.readthedocs.io/en/v1.0.1/)
- [v1.0.0](https://kyuubi.readthedocs.io/en/v1.0.0/)
- [1.3.0-incubating](https://kyuubi.apache.org/docs/r1.3.0-incubating/)
- [stable](https://kyuubi.apache.org/docs/stable/)

For 0.8 and earlier versions, please check the [Github Pages](https://apache.github.io/incubator-kyuubi/) directly.
For 1.2 and earlier versions, please check the [Github Pages](https://kyuubi.readthedocs.io/en/v1.2.0/) directly.

## Quick Start

Ready? [Getting Started](https://kyuubi.readthedocs.io/en/latest/quick_start/quick_start.html) with Kyuubi.
Ready? [Getting Started](https://kyuubi.apache.org/docs/latest/quick_start/quick_start.html) with Kyuubi.

## Contributing

All bits of help are welcome. You can make various types of contributions to Kyuubi, including the following but not limited to,

- Help new users in chat channel or share your success stories with us - [![Gitter](https://badges.gitter.im/kyuubi-on-spark/Lobby.svg)](https://gitter.im/kyuubi-on-spark/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
- Improve Documentation - [![Documentation Status](https://readthedocs.org/projects/kyuubi/badge/?version=latest)](https://kyuubi.readthedocs.io/en/latest/?badge=latest)
- Improve Documentation - [![Documentation Status](https://readthedocs.org/projects/kyuubi/badge/?version=latest)](https://kyuubi.apache.org/docs/latest/)
- Test releases - [![GitHub release](https://img.shields.io/github/release/apache/incubator-kyuubi.svg)](https://github.com/apache/incubator-kyuubi//releases)
- Improve test coverage - [![codecov](https://codecov.io/gh/apache/incubator-kyuubi/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/incubator-kyuubi)
- Report bugs and better help developers to reproduce
Expand All @@ -124,7 +119,7 @@ All bits of help are welcome. You can make various types of contributions to Kyu
- Promote to others
- Click the star button if you like this project

Before you start, we recommend that you check the [Contribution Guidelines](https://kyuubi.readthedocs.io/en/latest/community/contributions.html) first.
Before you start, we recommend that you check the [Contribution Guidelines](https://kyuubi.apache.org/docs/latest/community/contributions.html) first.

## Aside

Expand Down
2 changes: 1 addition & 1 deletion conf/kyuubi-defaults.conf.template
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@
# kyuubi.frontend.bind.port 10009
#

# Details in https://kyuubi.readthedocs.io/en/latest/deployment/settings.html
# Details in https://kyuubi.apache.org/docs/latest/deployment/settings.html
4 changes: 2 additions & 2 deletions docs/community/contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Thanks for sending a pull request!
Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
https://kyuubi.readthedocs.io/en/latest/community/contributions.html
https://kyuubi.apache.org/docs/latest/community/contributions.html
-->
### _Which issue are you going to fix?_
Expand All @@ -79,6 +79,6 @@ Please clarify why the changes are needed. For instance,
- [ ] Add screenshots for manual tests if appropriate
- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request
- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
```
2 changes: 1 addition & 1 deletion docs/deployment/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ You can configure the Kyuubi properties in `$KYUUBI_HOME/conf/kyuubi-defaults.co
# kyuubi.frontend.bind.port 10009
#

# Details in https://kyuubi.readthedocs.io/en/latest/deployment/settings.html
# Details in https://kyuubi.apache.org/docs/latest/deployment/settings.html
```

### Authentication
Expand Down
2 changes: 1 addition & 1 deletion docs/quick_start/quick_start_with_datagrip.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
### Get DataGrip And Install
Please go to [Download DataGrip](https://www.jetbrains.com/datagrip/download) to get and install an appropriate version for yourself.
### Get Kyuubi Started
[Get kyuubi server started](https://kyuubi.readthedocs.io/en/latest/quick_start/quick_start.html) before you try DataGrip with kyuubi.
[Get kyuubi server started](https://kyuubi.apache.org/docs/latest/quick_start/quick_start.html) before you try DataGrip with kyuubi.

For debugging purpose, you can use `tail -f` or `tailf` to track the server log.
## Configurations
Expand Down
2 changes: 1 addition & 1 deletion docs/quick_start/quick_start_with_helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Get kyuubi expose URL by running these commands:
```

#### Using hive beeline
[Using Hive Beeline](https://kyuubi.readthedocs.io/en/latest/quick_start/quick_start.html#using-hive-beeline) to opening a connection.
[Using Hive Beeline](https://kyuubi.apache.org/docs/latest/quick_start/quick_start.html#using-hive-beeline) to opening a connection.

#### Remove kyuubi
```bash
Expand Down

0 comments on commit 936a532

Please sign in to comment.