apache / amoro

Apache Amoro (incubating) is a Lakehouse management system built on open data lake formats.
https://amoro.apache.org/
Apache License 2.0
742 stars 260 forks source link

[Improvement]: Improve the project documentation #1510

Closed zhoujinsong closed 3 months ago

zhoujinsong commented 1 year ago

Search before asking

What would you like to be improved?

User documentation is one of the important means for users to understand and learn how to use a project.

The current user documentation of Arctic has the following shortcomings:

To address the above issues, we will optimize the documentation as follows:

How should we improve?

We will complete the documentation optimization task through the following steps:

It is worth noting that maintaining both English and Chinese documentation at the same time will bring a heavy workload. After this optimization, we will only keep the English documentation as the only language for continuous follow-up.

Are you willing to submit PR?

Subtasks

No response

Code of Conduct

zhoujinsong commented 1 year ago

The following sections, which are version-independent, will be split and maintained in a separate project on the official website:

zhoujinsong commented 1 year ago

The structure of the documentation will be adjusted as follows:

  1. Introduction
  2. Concepts 1.1 Catalogs 1.2 Self-optimizing 1.3 Table watermark
  3. Admin Guides 2.1 Deployment 2.2 Managing Catalogs 2.3 Managing Tables 2.4 Managing Optimizers 2.5 Using Kyuubi By Terminal 2.6 Metrics
  4. Configurations
  5. Formats 4.1 Overview 4.2 Iceberg 4.3 Mixed streaming
  6. Engines 5.1 Overview 5.2 Flink 5.3 Spark 5.4 Trino 5.5 Impala
zhongqishang commented 1 year ago

@zhoujinsong Contributing part is simple, I remember there was a document for the community-developed spec[1], I think it should be added to help new developers contribute faster.

[1] : https://docs.google.com/document/d/1Pwv1LflW3z5yq34qDpEYwSxOB3LIE5qoKQ_5Sv0IV1Y