Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MINOR] improve(doc): Improve the index to reorganize the order of the docs #1288

Merged
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/how-to-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Gravitino publishes the Docker image to [Docker Hub](https://hub.docker.com/r/da
You can run the Gravitino Docker image by:

```shell
docker run -d -i -p 8090:8090 datastrato/gravitino:0.3.0-SNAPSHOT
docker run -d -i -p 8090:8090 datastrato/gravitino:<version>
```

You can access the Gravitino Web UI by typing `http://localhost:8090` in your browser. or you
Expand Down
2 changes: 1 addition & 1 deletion docs/iceberg-rest-service.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Gravitino Iceberg REST catalog service"
title: "Iceberg REST catalog service"
slug: /iceberg-rest-service
keywords:
- Iceberg REST catalog
Expand Down
72 changes: 45 additions & 27 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,29 @@ To get started with Gravitino, please see [Getting started](./getting-started.md
* [Running on Google Cloud Platform](./getting-started.md#getting-started-on-google-cloud-platform):
a quick guide to start and use Gravitino on GCP.

## How to use Gravitino

Gravitino provides two SDKs to manage metadata from different catalogs in a unified way, one is
REST API, another is Java SDK. You can use either to manage metadata, please see
[Manage metadata using Gravitino](./manage-metadata-using-gravitino.md) for the details.

Also, you can find the complete REST API definition in
[Gravitino Open API](./api/rest/gravitino-rest-api),
Java SDK definition in [Gravitino Javadoc](pathname:///docs/0.3.0/api/java/index.html).

Gravitino provides a web UI to manage the metadata, you can visit the web UI in the browser via
the URL address `http://<ip-address>:8090`. Please see [Gravitino web UI](./webui.md) for the details.

Gravitino currently supports the following catalogs:

* [**Iceberg catalog**](./lakehouse-iceberg-catalog.md)
* [**Hive catalog**](./apache-hive-catalog.md)
* [**MySQL catalog**](./jdbc-mysql-catalog.md)
* [**PostgreSQL catalog**](./jdbc-postgresql-catalog.md)

Gravitino also provides an Iceberg REST catalog service for Iceberg table format, please see the
[Iceberg REST catalog service](./iceberg-rest-service.md) for the details.

## Gravitino playground

To experience Gravitino with other components easily, Gravitino provides a playground to run. It
Expand All @@ -61,37 +84,17 @@ to learn how to use the playground.

## Where to go from here

### Programming guides

* [Manage metadata using Gravitino](./manage-metadata-using-gravitino.md): provides the complete
functionalities of Gravitino metadata management. Including metalake, catalog, schema and
table management.
* [Gravitino Open API](./api/rest/gravitino-rest-api): provides the complete Open API definition of
Gravitino.
* [Gravitino Javadoc](pathname:///docs/0.3.0/api/java/index.html): provides the Javadoc for Gravitino API.

### Server administration

Gravitino provides several ways to configure and manage the Gravitino server. Please see:

* [How to customize Gravitino server configurations](./gravitino-server-config.md): provides the
complete Gravitino server configurations.
* [Security](./security.md): provides the security configurations for Gravitino, including HTTPS
and OAuth2 configurations.
* [Gravitino metrics](./metrics.md): provides the metrics configurations and detailed metrics list
of Gravitino server.

### Catalog details
### Catalogs

Gravitino supports different catalogs to manage the metadata in different sources. Please see:

* [Lakehouse Iceberg catalog](./lakehouse-iceberg-catalog.md): a complete guide to use Gravitino
* [Iceberg catalog](./lakehouse-iceberg-catalog.md): a complete guide to using Gravitino to
manage Apache Iceberg data.
* [How to set up Gravitino Apache Iceberg REST catalog service](./iceberg-rest-service.md): a
complete guide to use Gravitino as Apache Iceberg REST catalog service.
* [Apache Hive catalog](./apache-hive-catalog.md): a complete guide to use Gravitino manage Apache Hive data.
* [JDBC MySQL catalog](./jdbc-mysql-catalog.md): a complete guide to use Gravitino manage MySQL data.
* [JDBC PostgreSQL catalog](./jdbc-postgresql-catalog.md): a complete guide to use Gravitino manage PostgreSQL data.
* [Iceberg REST catalog service](./iceberg-rest-service.md): a
complete guide to use Gravitino as an Apache Iceberg REST catalog service.
* [Hive catalog](./apache-hive-catalog.md): a complete guide to using Gravitino manage Apache Hive data.
* [MySQL catalog](./jdbc-mysql-catalog.md): a complete guide to using Gravitino manage MySQL data.
* [PostgreSQL catalog](./jdbc-postgresql-catalog.md): a complete guide to using Gravitino manage PostgreSQL data.

### Trino connector

Expand All @@ -101,6 +104,21 @@ way. to use the Trino connector, please see:
* [How to use Gravitino Trino connector](./trino-connector/index.md): a complete guide to use Gravitino
Trino connector.

### Server administration

Gravitino provides several ways to configure and manage the Gravitino server. Please see:

* [Security](./security.md): provides security configurations for Gravitino, including HTTPS
and OAuth2 configurations.
* [Gravitino metrics](./metrics.md): provides metrics configurations and detailed metrics list
of the Gravitino server.

### Programming guides

* [Gravitino Open API](./api/rest/gravitino-rest-api): provides the complete Open API definition of
Gravitino.
* [Gravitino Javadoc](pathname:///docs/0.3.0/api/java/index.html): provides the Javadoc for the Gravitino API.

### Development guides

* [How to build Gravitino](./how-to-build.md): a complete guide to build Gravitino from
Expand Down
2 changes: 1 addition & 1 deletion docs/jdbc-mysql-catalog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "JDBC MySQL catalog"
title: "MySQL catalog"
slug: /jdbc-mysql-catalog
keywords:
- jdbc
Expand Down
2 changes: 1 addition & 1 deletion docs/jdbc-postgresql-catalog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "JDBC PostgreSQL catalog"
title: "PostgreSQL catalog"
slug: /jdbc-postgresql-catalog
keywords:
- jdbc
Expand Down
2 changes: 1 addition & 1 deletion docs/lakehouse-iceberg-catalog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Lakehouse Iceberg catalog"
title: "Iceberg catalog"
slug: /lakehouse-iceberg-catalog
keywords:
- lakehouse
Expand Down