tengqm opened a new pull request, #50:
URL: https://github.com/apache/gravitino-site/pull/50
This PR is about a revision to the docs.
There may still be some room for further improvements,
but this series of changes hopefully lay a solid foundation for future works.
The major revisions include:
1. Reorganize the site structure for clarity.
- Moved developer-facing documentation to `develop` subdirectory.
```
develop
├── docker-image-details.md
├── how-to-build.md
├── publish-docker-images.md
├── release-signing.md
├── testing.md
└── webui-testing.md
```
- Consolidated all CLI, python-client and Web UI documentation to the
`client` subdirectory.
- Split the huge CLI page into general introduction and several children
pages
as references organized by subjects (metalake, catalog … etc).
```
client
├── cli-reference
│ ├── auth.md
│ ├── catalog.md
│ ├── column.md
│ ├── fileset.md
│ ├── generic.md
│ ├── group.md
│ ├── metalake.md
│ ├── owner.md
│ ├── role.md
│ ├── schema.md
│ ├── table.md
│ ├── tag.md
│ ├── topic.md
│ └── user.md
├── cli.md
├── python-client.md
├── webui-reference
│ ├── catalogs.md
│ ├── filesets.md
│ ├── metalakes.md
│ ├── models.md
│ ├── schemas.md
│ ├── tables.md
│ └── topics.md
└── webui.md
```
- Reorganized all administration tasks into the `admin` subdirectory,
including server configuration, Iceberg REST server, server upgrade etc.
```
admin
├── iceberg-server.md
├── metalake.md
├── metrics.md
├── server-config.md
└── upgrade.md
```
- Introduced a hierarchy for different catalogs (relational, messaging,
fileset, model)
and moved all pages to their new homes.
```
catalogs
├── fileset
│ ├── gvfs
│ │ └── index.md
│ └── hadoop
│ ├── adls.md
│ ├── gcs.md
│ ├── hadoop-catalog.md
│ ├── index.md
│ ├── oss.md
│ └── s3.md
├── messaging
│ └── kafka
│ └── index.md
├── model
│ └── index.md
└── relational
├── distributed-table.md
├── hive
│ ├── cloud-storage.md
│ └── index.md
├── indexed-table.md
├── jdbc
│ ├── doris.md
│ ├── mysql.md
│ ├── oceanbase.md
│ └── postgresql.md
├── lakehouse
│ ├── hudi.md
│ ├── iceberg.md
│ └── paimon.md
├── partitioned-table.md
└── sorted-table.md
```
- Shuffled the connectors pages into the `connectors` subdirectory:
```
connectors
├── flink
│ ├── flink-catalog-hive.md
│ ├── flink-catalog-iceberg.md
│ ├── flink-catalog-paimon.md
│ └── index.md
├── spark
│ ├── index.md
│ ├── spark-authentication-with-gravitino.md
│ ├── spark-catalog-hive.md
│ ├── spark-catalog-iceberg.md
│ ├── spark-catalog-jdbc.md
│ ├── spark-catalog-paimon.md
│ └── spark-integration-test.md
└── trino
├── catalog-hive.md
├── catalog-iceberg.md
├── catalog-mysql.md
├── catalog-postgresql.md
├── configuration.md
├── development.md
├── index.md
├── installation.md
├── requirements.md
├── sql-support.md
├── supported-catalog.md
├── trino-cascading-query.md
└── trino-connector.md
```
- Moved GVFS page into catalog/fileset directory.
- Consolidated all installation related pages into the `install`
subdirectory.
Moved the relational backend storage page into that directory as well.
- Relocated all “playground” related contents into the `playground`
subdirectory.
2. Reworked the Gravitino site `sidebar.js` file, which is used to generate
the sidebar
for the documentation website.
- For each and every reorg task in `gravitino`, the change to the sidebar
(if needed)
is made and tested under the `gravitino-site` project.
- For all other changes, the change is tested for each commit at the
`gravitino-site`
to make sure the site builds okay.
3. Reworked most (not all) markdown tables to HTML tables.
Some preliminary tests prove that Markdown syntax can be used in HTML
cells.
Using HTML tables can help improve the readability of the document
sources.
4. Reworked most examples where the commands won’t work if directly copy
pasted.
For example, `curl` commands that carry a JSON payload.
5. Fixed some obvious syntax errors when reworking a page.
There are still quite some grammar or syntax issues to be fixed.
But I believe those can be left to future PRs.
6. Applied *Semantic Line Break* (https://sembr.org) style where appropriate.
7. Minor tweaks to list orders, event orders, etc.
8. Resynced changes to docs up to 2025/04/4-16:21 (UTC+8).
--
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: commits-unsubscr...@gravitino.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
