Skip to content

Commit

Permalink
[#1136] improvement(docs): Add the md suffix for every link in the …
Browse files Browse the repository at this point in the history
…markdown (#1137)

### What changes were proposed in this pull request?
 Add the `md` suffix for every link in the markdown

### Why are the changes needed?

Fix: #1136

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

### How was this patch tested?
Tested in Docunausars and markdown locally.

---------

Co-authored-by: Heng Qin <qqtt@123.com>
  • Loading branch information
qqqttt123 and Heng Qin authored Dec 13, 2023
1 parent 94aac03 commit aab86ed
Show file tree
Hide file tree
Showing 21 changed files with 103 additions and 103 deletions.
6 changes: 3 additions & 3 deletions docs/apache-hive-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The Hive catalog supports to create, update, and delete databases and tables in

### Catalog operations

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#catalogs-operations) for more details.
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino.md#catalogs-operations) for more details.

## Schema

Expand All @@ -55,7 +55,7 @@ The following table lists predefined schema properties for the Hive database. Ad

### Schema operations

see [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#schemas-operations).
see [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino.md#schemas-operations).

## Table

Expand Down Expand Up @@ -140,7 +140,7 @@ Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravit

#### Alter operations

Gravitino has already defined a unified set of [metadata operation interfaces](./manage-metadata-using-gravitino#alter-a-table), and almost all [Hive Alter operations](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-AlterTable/Partition/Column) have corresponding table update request which enable you to change the struct of an existing table.
Gravitino has already defined a unified set of [metadata operation interfaces](./manage-metadata-using-gravitino.md#alter-a-table), and almost all [Hive Alter operations](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-AlterTable/Partition/Column) have corresponding table update request which enable you to change the struct of an existing table.
The following table lists the mapping relationship between Hive Alter operations and Gravitino table update request.

##### Alter table
Expand Down
14 changes: 7 additions & 7 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ To begin using Gravitino on AWS, follow these steps:
5. Install Gravitino on the instance:
You can install Gravitino from the binary release package or Docker image, please follow the
[how-to-install](./how-to-install) to install Gravitino.
[how-to-install](./how-to-install.md) to install Gravitino.
Or, you can install Gravitino from scratch, please follow the documentation of
[how-to-build](./how-to-build) and [how-to-install](./how-to-install) to install Gravitino.
[how-to-build](./how-to-build.md) and [how-to-install](./how-to-install.md) to install Gravitino.
6. Start Gravitino using the gravitino.sh script:
Expand Down Expand Up @@ -109,10 +109,10 @@ To begin using Gravitino on GCP, follow these steps:
5. Install Gravitino on the instance:

You can install Gravitino from the binary release package or Docker image, please follow the
[how-to-install](./how-to-install) to install Gravitino.
[how-to-install](./how-to-install.md) to install Gravitino.

Or, you can install Gravitino from scratch, please follow the documentation of
[how-to-build](./how-to-build) and [how-to-install](./how-to-install) to install Gravitino.
[how-to-build](./how-to-build.md) and [how-to-install](./how-to-install.md) to install Gravitino.

6. Start Gravitino using the gravitino.sh script:

Expand All @@ -136,10 +136,10 @@ To use Gravitino locally on macOS or Linux, follow similar steps:
2. Install Gravitino:

You can install Gravitino from the binary release package or Docker image, please follow the
[how-to-install](./how-to-install) to install Gravitino.
[how-to-install](./how-to-install.md) to install Gravitino.

Or, you can install Gravitino from scratch, please follow the documentation of
[how-to-build](./how-to-build) and [how-to-install](./how-to-install) to install Gravitino.
[how-to-build](./how-to-build.md) and [how-to-install](./how-to-install.md) to install Gravitino.

3. Start Gravitino using the gravitino.sh script:

Expand Down Expand Up @@ -191,7 +191,7 @@ newgrp docker
You can install and run all the programs as Docker containers by using the
[gravitino-playground](https://github.com/datastrato/gravitino-playground). For the details of
how to run the playground, please see [how-to-use-the-playground](./how-to-use-the-playground)
how to run the playground, please see [how-to-use-the-playground](./how-to-use-the-playground.md)
## Installing Gravitino playground locally
Expand Down
16 changes: 8 additions & 8 deletions docs/gravitino-server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ It's highly recommend that you change the default value of `gravitino.entity.sto
|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------------|---------------|
| `gravitino.auxService.names ` | The auxiliary service name of the Gravitino Iceberg REST server, use **`iceberg-rest`** for the Gravitino Iceberg REST server. | (none) | 0.2.0 |

Please refer to [Iceberg REST catalog service](iceberg-rest-service) for Iceberg REST catalog service configurations.
Please refer to [Iceberg REST catalog service](iceberg-rest-service.md) for Iceberg REST catalog service configurations.

### Security configuration

Please refer to [security](security) for HTTPS and Authentication configurations.
Please refer to [security](security.md) for HTTPS and Authentication configurations.

## Gravitino catalog properties configuration

Expand All @@ -88,12 +88,12 @@ Explicit specifications take precedence over the formal configurations.
These rules only apply on the catalog properties, doesn't affect on the schema or table properties.
:::

| catalog provider | catalog properties | catalog properties configuration file path |
|---------------------|--------------------------------------------------------------------------------------|----------------------------------------------------------|
| `hive` | [Hive catalog properties](apache-hive-catalog#catalog-properties) | `catalogs/hive/conf/hive.conf` |
| `lakehouse-iceberg` | [Lakehouse Iceberg catalog properties](lakehouse-iceberg-catalog#catalog-properties) | `catalogs/lakehouse-iceberg/conf/lakehouse-iceberg.conf` |
| `jdbc-mysql` | [MySQL catalog properties](jdbc-mysql-catalog#catalog-properties) | `catalogs/jdbc-mysql/conf/jdbc-mysql.conf` |
| `jdbc-postgresql` | [PostgreSQL catalog properties](jdbc-postgresql-catalog#catalog-properties) | `catalogs/jdbc-postgresql/conf/jdbc-postgresql.conf` |
| catalog provider | catalog properties | catalog properties configuration file path |
|---------------------|-----------------------------------------------------------------------------------------|----------------------------------------------------------|
| `hive` | [Hive catalog properties](apache-hive-catalog.md#catalog-properties) | `catalogs/hive/conf/hive.conf` |
| `lakehouse-iceberg` | [Lakehouse Iceberg catalog properties](lakehouse-iceberg-catalog.md#catalog-properties) | `catalogs/lakehouse-iceberg/conf/lakehouse-iceberg.conf` |
| `jdbc-mysql` | [MySQL catalog properties](jdbc-mysql-catalog.md#catalog-properties) | `catalogs/jdbc-mysql/conf/jdbc-mysql.conf` |
| `jdbc-postgresql` | [PostgreSQL catalog properties](jdbc-postgresql-catalog.md#catalog-properties) | `catalogs/jdbc-postgresql/conf/jdbc-postgresql.conf` |

:::info
Gravitino server automatically add catalog properties configuration dir to classpath.
Expand Down
6 changes: 3 additions & 3 deletions docs/how-to-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ configured correctly. To confirm the Java version, you can simply run `${JAVA_HO

Before installing Gravitino, make sure you have Gravitino binary distribution package. You can
download the latest Gravitino binary distribution Package from [GitHub](https://github.com/datastrato/gravitino/releases),
or you can build it yourself by following the instructions in [How to Build Gravitino](./how-to-build).
or you can build it yourself by following the instructions in [How to Build Gravitino](./how-to-build.md).

If you build Gravitino yourself by `./gradlew compileDistribution` command, you can find the
Gravitino binary distribution package in `distribution/package` directory.
Expand Down Expand Up @@ -49,7 +49,7 @@ The Gravitino binary distribution package contains the following files:

The Gravitino server configuration file is `conf/gravitino.conf`. You can configure the Gravitino
server by modifying this file. Basic configurations are already added to this file, all the
configurations list in [Gravitino Server Configurations](./gravitino-server-config).
configurations list in [Gravitino Server Configurations](./gravitino-server-config.md).

#### Configure Gravitino server log

Expand Down Expand Up @@ -142,4 +142,4 @@ compose file.

For the details, you can review the
[Gravitino playground repository](https://github.com/datastrato/gravitino-playground) and
[playground example](./how-to-use-the-playground).
[playground example](./how-to-use-the-playground.md).
2 changes: 1 addition & 1 deletion docs/how-to-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ are end-to-end tests that covers the whole system.
:::note before test
* If you want to run the complete integration test suites, you need to install Docker in your
environment.
* Please refer to [How to build Gravitino](./how-to-build) for more details to make sure you have
* Please refer to [How to build Gravitino](./how-to-build.md) for more details to make sure you have
a build environment ready.
* [OrbStack](https://orbstack.dev/) is highly recommended to replace Docker Desktop for
macOS. OrbStack automatically configures the network between Docker containers.
Expand Down
4 changes: 2 additions & 2 deletions docs/iceberg-rest-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Gravitino Iceberg REST Server follows the [Apache Iceberg REST API specifica
- Supports the Apache Iceberg REST API defined in Iceberg 1.3.1, supports all namespace and table interfaces. `Token`, `ReportMetrics`, and `Config` interfaces aren't supported yet.
- Works as a catalog proxy, supporting `HiveCatalog` and `JDBCCatalog`.
- When writing to HDFS, the Gravitino Iceberg REST catalog service can only operate as the specified HDFS user and
doesn't support proxying to other HDFS users. See [How to access Apache Hadoop](gravitino-server-config) for more details.
doesn't support proxying to other HDFS users. See [How to access Apache Hadoop](gravitino-server-config.md) for more details.

:::info
Builds with Apache Iceberg `1.3.1`. The Apache Iceberg table format version is `1` by default.
Expand All @@ -25,7 +25,7 @@ Builds with Hadoop 2.10.x, there may compatibility issue when accessing Hadoop 3

## How to start the Gravitino Iceberg REST catalog service

Deploy the Gravitino server to the `GRAVITINO_HOME` directory. You can find the configuration options in [`$GRAVITINO_HOME/conf/gravitino.conf`](gravitino-server-config).
Deploy the Gravitino server to the `GRAVITINO_HOME` directory. You can find the configuration options in [`$GRAVITINO_HOME/conf/gravitino.conf`](gravitino-server-config.md).

### Gravitino Iceberg REST catalog service configuration

Expand Down
52 changes: 26 additions & 26 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,59 +11,59 @@ Gravitino is a high-performance, geo-distributed, and federated metadata lake. I
metadata directly in different sources, types, and regions. It also provides users with unified
metadata access for data and AI assets.

[Learn more](./overview)&rarr;
[Learn more](./overview.md)&rarr;

## Downloading

You can get Graviton from the [GitHub release page](https://github.com/datastrato/gravitino/releases),
or you can build Gravitino from source, please see [How to build Gravitino](./how-to-build).
or you can build Gravitino from source, please see [How to build Gravitino](./how-to-build.md).

Gravitino runs on both Linux and macOS, and requires Java 8. Gravitino trino-connector runs with
Trino, and requires Java 17. This should include JVMs on x86_64 and
ARM64. It's easy to run locally on one machine --- all you need is to have `java` installed on
your system `PATH`, or the `JAVA_HOME` environment variable pointing to a Java installation.

See [How to install Gravitino](./how-to-install) to learn how to install Gravitino server.
See [How to install Gravitino](./how-to-install.md) to learn how to install Gravitino server.

Gravitino provides Docker image on [Docker Hub](https://hub.docker.com/u/datastrato).
Please pull the image and run it. For the details of Gravitino Docker image, please see
[Dock image details](./docker-image-details).
[Dock image details](./docker-image-details.md).

Gravitino also provides a playground to experience the whole Gravitino system with other components.
Please see the [Gravitino playground repository](https://github.com/datastrato/gravitino-playground)
and [How to use the playground](./how-to-use-the-playground).
and [How to use the playground](./how-to-use-the-playground.md).

## Getting started

To get started with Gravitino, please see [Getting started](./getting-started) for the details.
To get started with Gravitino, please see [Getting started](./getting-started.md) for the details.

* [Getting started locally](./getting-started#getting-started-locally): a quick guide to start
* [Getting started locally](./getting-started.md#getting-started-locally): a quick guide to start
and use Gravitino locally.
* [Running on Amazon Web Services](./getting-started#getting-started-on-amazon-web-services): a
* [Running on Amazon Web Services](./getting-started.md#getting-started-on-amazon-web-services): a
quick guide to start and use Gravitino on AWS.
* [Running on Google Cloud Platform](./getting-started#getting-started-on-google-cloud-platform):
* [Running on Google Cloud Platform](./getting-started.md#getting-started-on-google-cloud-platform):
a quick guide to start and use Gravitino on GCP.

## Gravitino playground

To experience Gravitino with other components simply, Gravitino provides a playground to run. It
integrates Apache Hadoop, Apache Hive, Trino, MySQL, PostgreSQL, and Gravitino together as a
complete environment. To experience the whole features, please also see
[Getting started](./getting-started) and [How to use the Gravitino playground](./how-to-use-the-playground)
[Getting started](./getting-started.md) and [How to use the Gravitino playground](./how-to-use-the-playground.md)
to learn how to use the playground.

* [Install Gravitino playground on AWS or GCP](./getting-started#installing-gravitino-playground-on-aws-or-google-cloud-platform):
* [Install Gravitino playground on AWS or GCP](./getting-started.md#installing-gravitino-playground-on-aws-or-google-cloud-platform):
a quick guide to start and use Gravitino playground on AWS or GCP.
* [Install Gravitino playground locally](./getting-started#installing-gravitino-playground-locally):
* [Install Gravitino playground locally](./getting-started.md#installing-gravitino-playground-locally):
a quick guide to start and use Gravitino playground locally.
* [How to use the Gravitino playground](./how-to-use-the-playground): provides an example of how
* [How to use the Gravitino playground](./how-to-use-the-playground.md): provides an example of how
to use Gravitino and other components together.

## Where to go from here

### Programming guides

* [Manage metadata using Gravitino](./manage-metadata-using-gravitino): provides the complete
* [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](pathname:///docs/0.3.0/api/rest/index.html): provides the complete Open API definition of
Expand All @@ -74,24 +74,24 @@ to learn how to use the playground.

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

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

### Catalog details

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

* [Lakehouse Iceberg catalog](./lakehouse-iceberg-catalog): a complete guide to use Gravitino
* [Lakehouse Iceberg catalog](./lakehouse-iceberg-catalog.md): a complete guide to use Gravitino
manage Apache Iceberg data.
* [How to set up Gravitino Apache Iceberg REST catalog service](./iceberg-rest-service): a
* [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): a complete guide to use Gravitino manage Apache Hive data.
* [JDBC MySQL catalog](./jdbc-mysql-catalog): a complete guide to use Gravitino manage MySQL data.
* [JDBC PostgreSQL catalog](./jdbc-postgresql-catalog): a complete guide to use Gravitino manage PostgreSQL data.
* [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.

### Trino connector

Expand All @@ -103,11 +103,11 @@ way. to use the Trino connector, please see:

### Development guides

* [How to build Gravitino](./how-to-build): a complete guide to build Gravitino from
* [How to build Gravitino](./how-to-build.md): a complete guide to build Gravitino from
source.
* [How to test Gravitino](./how-to-test): a complete guide to run Gravitino unit tests and
* [How to test Gravitino](./how-to-test.md): a complete guide to run Gravitino unit tests and
integration tests.
* [How to sign and verify a Gravitino releases](./how-to-sign-releases): a guide to sign and verify
* [How to sign and verify a Gravitino releases](./how-to-sign-releases.md): a guide to sign and verify
a Gravitino release.
* [Publish Docker images](./publish-docker-images): a guide to publish Gravitino Docker images,
* [Publish Docker images](./publish-docker-images.md): a guide to publish Gravitino Docker images,
also list the change logs of Gravitino CI Docker images and release images.
4 changes: 2 additions & 2 deletions docs/jdbc-mysql-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You must download the corresponding JDBC driver to the `catalogs/jdbc-mysql/libs

### Catalog operations

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#catalogs-operations) for more details.
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino.md#catalogs-operations) for more details.

## Schema

Expand All @@ -61,7 +61,7 @@ Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravit

### Schema operations

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#schemas-operations) for more details.
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino.md#schemas-operations) for more details.

## Table

Expand Down
4 changes: 2 additions & 2 deletions docs/jdbc-postgresql-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In PostgreSQL, the database corresponds to the Gravitino catalog, and the schema

### Catalog operations

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#catalogs-operations) for more details.
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino.md#catalogs-operations) for more details.

## Schema

Expand All @@ -67,7 +67,7 @@ Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravit

### Schema operations

Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino#schemas-operations) for more details.
Please refer to [Manage Metadata Using Gravitino](./manage-metadata-using-gravitino.md#schemas-operations) for more details.

## Table

Expand Down
Loading

0 comments on commit aab86ed

Please sign in to comment.