From 892b28825c58f89a2ba4495599e049f4238dd66f Mon Sep 17 00:00:00 2001 From: SeanAverS Date: Tue, 15 Oct 2024 17:14:52 -0700 Subject: [PATCH 1/2] [IMPROVEMENT] fix(readme): link to documentation website --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 94f1a1b9fe2..be4396463e0 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Gravitino is open source software available under the Apache 2.0 license. For in ## Online documentation -The latest Gravitino documentation is in the [doc folder](docs). This README file only contains basic setup instructions. +The latest Gravitino documentation is available on our [documentation website](https://datastrato.ai/docs/0.4.0/). This README file only contains basic setup instructions. ## Building Apache Gravitino From 0d09a8672820549bc035650bb3c68af8e2c99689 Mon Sep 17 00:00:00 2001 From: SeanAverS Date: Fri, 18 Oct 2024 11:57:07 -0700 Subject: [PATCH 2/2] [IMPORVEMENT] fix: add remaining documentation website links --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index be4396463e0..660ee7d323b 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,11 @@ Gravitino aims to provide several key features: ## Contributing to Apache Gravitino -Gravitino is open source software available under the Apache 2.0 license. For information on how to contribute to Gravitino, please see the [Contribution guidelines](CONTRIBUTING.md). +Gravitino is open source software available under the Apache 2.0 license. For information on how to contribute to Gravitino, please see the [Contribution guidelines](https://gravitino.apache.org/contrib/). ## Online documentation -The latest Gravitino documentation is available on our [documentation website](https://datastrato.ai/docs/0.4.0/). This README file only contains basic setup instructions. +The latest Gravitino documentation is available on our [official website](https://gravitino.apache.org/docs/latest/). This README file only contains basic setup instructions. ## Building Apache Gravitino @@ -77,7 +77,7 @@ to build a compressed distribution package. The directory `distribution` contains the generated binary distribution package. -Please see [How to build Gravitino](docs/how-to-build.md) for details on building and testing Gravitino. +Please see [How to build Gravitino](https://gravitino.apache.org/docs/latest/how-to-build/) for details on building and testing Gravitino. ## Quick start @@ -110,17 +110,17 @@ And press `CTRL+C` to stop the Gravitino server. ### Gravitino Iceberg REST catalog service -Gravitino provides Iceberg REST catalog service to manage Iceberg. For more details, please refer to [Gravitino Iceberg REST catalog service](docs/iceberg-rest-service.md). +Gravitino provides Iceberg REST catalog service to manage Iceberg. For more details, please refer to [Gravitino Iceberg REST catalog service](https://gravitino.apache.org/docs/latest/iceberg-rest-service/). ### Using Trino with Apache Gravitino -Gravitino provides a Trino connector to access the metadata in Gravitino. To use Trino with Gravitino, please follow the [trino-gravitino-connector doc](docs/trino-connector/index.md). +Gravitino provides a Trino connector to access the metadata in Gravitino. To use Trino with Gravitino, please follow the [trino-gravitino-connector doc](https://gravitino.apache.org/docs/latest/trino-connector/index/). ## Development guide -1. [How to build Gravitino](docs/how-to-build.md) -2. [How to test Gravitino](docs/how-to-test.md) -3. [How to publish Docker images](docs/publish-docker-images.md) +1. [How to build Gravitino](https://gravitino.apache.org/docs/latest/how-to-build/) +2. [How to test Gravitino](https://gravitino.apache.org/docs/latest/how-to-test/) +3. [How to publish Docker images](https://gravitino.apache.org/docs/latest/publish-docker-images) ## License