Skip to content

Commit

Permalink
[MINOR] docs: fix md links issue (#4908)
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?
fix md links issue

### Why are the changes needed?
N/A

Fix: # (issue)

### Does this PR introduce _any_ user-facing change?
N/A

### How was this patch tested?
N/A
  • Loading branch information
LauraXia123 authored Sep 11, 2024
1 parent 228a1f5 commit 9a7ec10
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ If you have your own Apache Gravitino setup and want to use Apache Hive:

If you prefer to get started quickly and use Docker for Gravitino, Apache Hive, Trino, and others:

- on AWS or Google Cloud Platform, see [Installing Gravitino playground on AWS or Google Cloud Platform](#installing-gravitino-playground-on-aws-or-google-cloud-platform)
- locally, see [Installing Gravitino playground locally](#installing-gravitino-playground-locally)
- on AWS or Google Cloud Platform, see [Installing Gravitino playground on AWS or Google Cloud Platform](#installing-apache-gravitino-playground-on-aws-or-google-cloud-platform)
- locally, see [Installing Gravitino playground locally](#installing-apache-gravitino-playground-locally)

If you are using AWS and want to access the instance remotely, be sure to read [Accessing Gravitino on AWS externally](#accessing-gravitino-on-aws-externally)
If you are using AWS and want to access the instance remotely, be sure to read [Accessing Gravitino on AWS externally](#accessing-apache-gravitino-on-aws-externally)

### Index

Expand Down Expand Up @@ -228,7 +228,7 @@ how to run the playground, see [how-to-use-the-playground](./how-to-use-the-play
## Installing Apache Gravitino playground locally
The same steps for installing the playground on AWS or Google Cloud Platform apply when installing it locally. Follow [Installing Gravitino playground on AWS or Google Cloud Platform](#installing-gravitino-playground-on-aws-or-google-cloud-platform).
The same steps for installing the playground on AWS or Google Cloud Platform apply when installing it locally. Follow [Installing Gravitino playground on AWS or Google Cloud Platform](#installing-apache-gravitino-playground-on-aws-or-google-cloud-platform).
## Using REST to interact with Apache Gravitino
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ license: "This software is licensed under the Apache License version 2."

- [Prerequisites](#prerequisites)
- [Quick start](#quick-start)
- [How to Build Apache Gravitino on Windows (Using WSL)](#how-to-build-gravitino-on-windows-using-wsl)
- [How to Build Apache Gravitino on Windows (Using WSL)](#how-to-build-apache-gravitino-on-windows-using-wsl)

## Prerequisites

Expand Down
8 changes: 3 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,7 @@ REST API and the Java SDK. You can use either to manage metadata. See

Also, you can find the complete REST API definition in
[Gravitino Open API](./api/rest/gravitino-rest-api),
Java SDK definition in [Gravitino Java doc](pathname:///docs/0.6.0-incubating/api/java/index.html),
and Python SDK definition in [Gravitino Python doc](pathname:///docs/0.6.0-incubating/api/python/gravitino.html).
Java SDK definition in [Gravitino Java doc](pathname:///docs/0.6.0-incubating/api/java/index.html).

Gravitino provides a web UI to manage the metadata. Visit the web UI in the browser via `http://<ip-address>:8090`. See [Gravitino web UI](./webui.md) for details.

Expand Down Expand Up @@ -90,9 +89,9 @@ integrates Apache Hadoop, Apache Hive, Trino, MySQL, PostgreSQL, and Gravitino t
complete environment. To experience all the features, see
[Getting started](./getting-started.md) and [How to use the Gravitino playground](./how-to-use-the-playground.md).

* [Install Gravitino playground on AWS or GCP](./getting-started.md#installing-gravitino-playground-on-aws-or-google-cloud-platform):
* [Install Gravitino playground on AWS or GCP](./getting-started.md#installing-apache-gravitino-playground-on-aws-or-google-cloud-platform):
a quick guide to starting and using the Gravitino playground on AWS or GCP.
* [Install Gravitino playground locally](./getting-started.md#installing-gravitino-playground-locally):
* [Install Gravitino playground locally](./getting-started.md#installing-apache-gravitino-playground-locally):
a quick guide to starting and using the Gravitino playground locally.
* [How to use the Gravitino playground](./how-to-use-the-playground.md): provides an example of how
to use Gravitino and other components together.
Expand Down Expand Up @@ -165,7 +164,6 @@ Gravitino provides security configurations for Gravitino, including HTTPS, authe

* [Gravitino Open API](./api/rest/gravitino-rest-api): provides the complete Open API definition of Gravitino.
* [Gravitino Java doc](pathname:///docs/0.6.0-incubating/api/java/index.html): provides the Javadoc for the Gravitino API.
* [Gravitino Python doc](pathname:///docs/0.6.0-incubating/api/python/gravitino.html) provides the Pydoc for the Gravitino API.

### Development guides

Expand Down

0 comments on commit 9a7ec10

Please sign in to comment.