jerryshao commented on code in PR #4113:
URL: https://github.com/apache/gravitino/pull/4113#discussion_r1700052313
##########
docs/how-to-install.md:
##########
@@ -30,20 +30,28 @@ The Gravitino binary distribution package contains the
following files:
```text
|── ...
└── distribution/package
- |── bin/gravitino.sh # Gravitino server Launching scripts.
+ |── bin/
+ | ├── gravitino.sh # Gravitino server Launching
scripts.
+ | └── gravitino-iceberg-rest-server.sh # Gravitino Iceberg REST
server Launching scripts.
|── catalogs
- | └── hive/ # Hive catalog dependencies and
configurations.
- | └── lakehouse-iceberg/ # Apache Iceberg catalog dependencies and
configurations.
- | └── jdbc-mysql/ # JDBC MySQL catalog dependencies and
configurations.
- | └── jdbc-postgresql/ # JDBC PostgreSQL catalog dependencies and
configurations.
- |── conf/ # All configurations for Gravitino.
- | ├── gravitino.conf # Gravitino server configuration.
- | ├── gravitino-env.sh # Environment variables, etc., JAVA_HOME,
GRAVITINO_HOME, and more.
- | └── log4j2.properties # log4j configuration for the Gravitino
server.
- |── libs/ # Gravitino server dependencies libraries.
- |── logs/ # Gravitino server logs. Automatically
created after the Gravitino server starts.
- |── data/ # Default directory for the Gravitino
server to store data.
- └── scripts/ # Extra scripts for Gravitino.
+ | └── hadoop/ # Apache Hadoop catalog
dependencies and configurations.
+ | └── hive/ # Apache Hive catalog
dependencies and configurations.
+ | └── jdbc-doris/ # JDBC doris catalog
dependencies and configurations.
+ | └── jdbc-mysql/ # JDBC MySQL catalog
dependencies and configurations.
+ | └── jdbc-postgresql/ # JDBC PostgreSQL catalog
dependencies and configurations.
+ | └── kafka/ # Apache Kafka PostgreSQL
catalog dependencies and configurations.
+ | └── lakehouse-iceberg/ # Apache Iceberg catalog
dependencies and configurations.
+ | └── lakehouse-paimon/ # Apache Paimon catalog
dependencies and configurations.
+ |── conf/ # All configurations for
Gravitino.
+ | ├── gravitino.conf # Gravitino server and
Gravitino Iceberg REST server configuration.
+ | ├── gravitino-iceberg-rest-server.conf # Gravitino server
configuration.
+ | ├── gravitino-env.sh # Environment variables, etc.,
JAVA_HOME, GRAVITINO_HOME, and more.
+ | └── log4j2.properties # log4j configuration for the
Gravitino server and Gravitino Iceberg REST server.
+ |── libs/ # Gravitino server
dependencies libraries.
+ |── logs/ # Gravitino server and
Gravitino Iceberg REST server logs. Automatically created after the server
starts.
+ |── data/ # Default directory for the
Gravitino server to store data.
+ |── iceberg-rest-server/ # Gravitino Iceberg REST
server package and dependencies libraries.
+ └── scripts/ # Extra scripts for Gravitino.
```
Review Comment:
I think it's not enough, you should have separate paragraphs to describe how
to start, stop, etc.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
