This is an automated email from the ASF dual-hosted git repository.
yuqi4733 pushed a commit to branch branch-0.6
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/branch-0.6 by this push:
new 51521e2e7 [MINOR] improve(doc): Improve the doc to add more content
(#4536)
51521e2e7 is described below
commit 51521e2e7f2033f81fc6eca87db785ed9e202adb
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Thu Aug 15 19:38:07 2024 +0800
[MINOR] improve(doc): Improve the doc to add more content (#4536)
### What changes were proposed in this pull request?
Polish the doc to add more content.
### Why are the changes needed?
Fix the issues in doc.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
N/A
Co-authored-by: Jerry Shao <[email protected]>
---
docs/getting-started.md | 6 +++---
docs/index.md | 23 ++++++++++++++---------
docs/open-api/tags.yaml | 6 +++---
3 files changed, 20 insertions(+), 15 deletions(-)
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 01220ae67..420d583d7 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -317,7 +317,7 @@ After completing these steps, you should be able to access
the Gravitino REST in
1. **Explore documentation:**
- Delve deeper into the Gravitino documentation for advanced features and
configuration options.
- - Check out https://datastrato.ai/docs
+ - Check out https://gravitino.apache.org/docs/latest
2. **Community engagement:**
- Join the Gravitino community forums to connect with other users, share
experiences, and seek assistance if needed.
@@ -325,12 +325,12 @@ After completing these steps, you should be able to
access the Gravitino REST in
- Check out our Slack channel in ASF Slack: https://the-asf.slack.com
3. **Read our blogs:**
- - Check out: https://gravitino.apache.org/blog (coming soon)
+ - Check out: https://gravitino.apache.org/blog
4. **Continuous updates:**
- Stay informed about Gravitino updates and new releases to benefit from
the latest features, optimizations, and security
enhancements.
- - Check out our Website: https://gravitino.apache.org (coming soon)
+ - Check out our Website: https://gravitino.apache.org
This document is just the beginning. You're welcome to customize your
Gravitino setup based on your requirements and to explore the vast
possibilities this powerful tool offers. If you encounter any issues or have
questions, you can always connect with the Gravitino community for assistance.
diff --git a/docs/index.md b/docs/index.md
index 7eca72edc..0d680236f 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -14,7 +14,7 @@ metadata access for data and AI assets.
## Downloading
-You can get Gravitino from the [GitHub release
page](https://github.com/apache/gravitino/releases),
+You can get Gravitino from the [download
page](https://gravitino.apache.org/downloads),
or you can build Gravitino from source code. See [How to build
Gravitino](./how-to-build.md).
Gravitino runs on both Linux and macOS platforms, and it requires the
installation of Java 8, Java 11, or Java 17. Gravitino trino-connector runs with
@@ -58,8 +58,9 @@ REST API and the Java SDK. You can use either to manage
metadata. See
messaging metadata.
Also, you can find the complete REST API definition in
-[Gravitino Open API](./api/rest/gravitino-rest-api), and the
-Java SDK definition in [Gravitino
Javadoc](pathname:///docs/0.6.0-incubating/api/java/index.html).
+[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).
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.
@@ -82,9 +83,6 @@ Gravitino currently supports the following catalogs:
* [**Kafka catalog**](./kafka-catalog.md)
-Gravitino also provides an Iceberg REST catalog service for the Iceberg table
format. See the
-[Iceberg REST catalog service](./iceberg-rest-service.md) for details.
-
## Apache Gravitino playground
To experience Gravitino with other components easily, Gravitino provides a
playground to run. It
@@ -115,6 +113,13 @@ Gravitino supports different catalogs to manage the
metadata in different source
using Hadoop Compatible File System (HCFS).
* [Kafka catalog](./kafka-catalog.md): a complete guide to using Gravitino to
manage Kafka topics metadata.
+### Governance
+
+Gravitino provides governance features to manage metadata in a unified way.
See:
+
+* [Manage tags in Gravitino](./manage-tags-in-gravitino.md): a complete guide
to using Gravitino
+ to manage tags.
+
### Gravitino Iceberg REST catalog service
* [Iceberg REST catalog service](./iceberg-rest-service.md): a complete guide
to using Gravitino as an Apache Iceberg REST catalog service.
@@ -158,9 +163,9 @@ Gravitino provides security configurations for Gravitino,
including HTTPS, authe
### Programming guides
-* [Gravitino Open API](./api/rest/gravitino-rest-api): provides the complete
Open API definition of
- Gravitino.
-* [Gravitino Javadoc](pathname:///docs/0.6.0-incubating/api/java/index.html):
provides the Javadoc for the Gravitino API.
+* [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
diff --git a/docs/open-api/tags.yaml b/docs/open-api/tags.yaml
index 51d211c09..61d9ae1fc 100644
--- a/docs/open-api/tags.yaml
+++ b/docs/open-api/tags.yaml
@@ -188,7 +188,7 @@ paths:
get:
tags:
- tag
- summary: List tags (names) associated with the specified metadata object
+ summary: List tags (names) for metadata object
operationId: listObjectTags
parameters:
- $ref: "#/components/parameters/details"
@@ -214,7 +214,7 @@ paths:
post:
tags:
- tag
- summary: Associate tags with the specified metadata object
+ summary: Associate tags with metadata object
operationId: associateTags
requestBody:
content:
@@ -256,7 +256,7 @@ paths:
get:
tags:
- tag
- summary: get associated tag for metadata object with specified tag name
+ summary: Get tag for metadata object
operationId: getObjectTag
parameters:
- $ref: "#/components/parameters/details"
