Skip to content

Commit

Permalink
[#5419] fix(doc): Fix the doc bug and add some missing doc links (#5420)
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?

Fix the doc bug and add some missing doc links.

### Why are the changes needed?

Fix: #5419 

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

Local verification.
  • Loading branch information
jerryshao authored Nov 1, 2024
1 parent eb6443e commit 240bac9
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
4 changes: 4 additions & 0 deletions docs/docker-image-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ Changelog

### Trino image

Changelog
- apache/gravitino-playground:trino-435-gravitino-0.7.0-incubating
- Use Gravitino release 0.7.0-incubating Dockerfile to build the image.

Changelog
- apache/gravitino-playground:trino-435-gravitino-0.6.1-incubating
- Use Gravitino release 0.6.1-incubating Dockerfile to build the image.
Expand Down
8 changes: 4 additions & 4 deletions docs/gravitino-server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,10 @@ The `AuditLogWriter` defines an interface that enables the writing of metadata a

Writer configuration begins with `gravitino.audit.writer.${name}`, where ${name} is replaced with the actual writer name defined in method `name()`. `FileAuditWriter` is a default implement to log audit information, whose name is `file`.

| Property name | Description | Default value | Required | Since Version |
|-----------------------------------------------------|-----------------------------------------------------------------------------------------|---------------------|----------|----------------------------|
| `gravitino.audit.writer.file.fileName` | The audit log file name, the path is ${sys:gravitino.log.path}/${fileName}. | gravitino_audit.log | NO | 0.7.0-incubating |
| `gravitino.audit.writer.file.append` | Whether the log will be written to the end or the beginning of the file. | true | NO | 0.7.0-incubating |
| Property name | Description | Default value | Required | Since Version |
|----------------------------------------|-------------------------------------------------------------------------------|---------------------|----------|------------------|
| `gravitino.audit.writer.file.fileName` | The audit log file name, the path is `${sys:gravitino.log.path}/${fileName}`. | gravitino_audit.log | NO | 0.7.0-incubating |
| `gravitino.audit.writer.file.append` | Whether the log will be written to the end or the beginning of the file. | true | NO | 0.7.0-incubating |

### Security configuration

Expand Down
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ 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.8.0-incubating-SNAPSHOT/api/java/index.html).
Java SDK definition in [Gravitino Java doc](pathname:///docs/0.8.0-incubating-SNAPSHOT/api/java/index.html),
and Python SDK definition in [Gravitino Python doc](pathname:///docs/0.8.0-incubating-SNAPSHOT/api/python/index.html).

Gravitino also 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 @@ -171,6 +172,7 @@ 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.8.0-incubating-SNAPSHOT/api/java/index.html): provides the Javadoc for the Gravitino API.
* [Gravitino Python doc](pathname:///docs/0.8.0-incubating-SNAPSHOT/api/python/index.html): provides the Python doc for the Gravitino API.

### Development guides

Expand Down

0 comments on commit 240bac9

Please sign in to comment.