Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Improvement]: Improve the project documentation #1510

Closed
2 of 3 tasks
Tracked by #1333
zhoujinsong opened this issue Jun 5, 2023 · 3 comments
Closed
2 of 3 tasks
Tracked by #1333

[Improvement]: Improve the project documentation #1510

zhoujinsong opened this issue Jun 5, 2023 · 3 comments

Comments

@zhoujinsong
Copy link
Contributor

zhoujinsong commented Jun 5, 2023

Search before asking

  • I have searched in the issues and found no similar issues.

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:

  • No English documentation is provided, which limits the user group.
  • There is no distinction between versions, which makes it difficult for users of previous versions to find the content they need.
  • The documentation directory is not split reasonably, making it difficult for users to quickly find the content they want.

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

  • Provide an English version of the documentation.
  • Split version-related and unrelated content for separate management.
  • Optimize the directory structure.

How should we improve?

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

  • Split version-related and version-unrelated content. Version-unrelated content will be managed in a separate project on the official website, while version-related content will still be managed together with the main project.
  • Rearrange the document directory structure.
  • Supplement and translate the existing documentation into English.

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?

  • Yes I am willing to submit a PR!

Subtasks

No response

Code of Conduct

@zhoujinsong
Copy link
Contributor Author

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

  • Overview
  • Quick Start
  • Benchmark
  • Roadmap
  • Contributing

@zhoujinsong
Copy link
Contributor Author

zhoujinsong commented Jun 5, 2023

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
Copy link
Contributor

@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

@zhoujinsong zhoujinsong mentioned this issue Aug 2, 2023
27 tasks
@czy006 czy006 closed this as completed Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants