StarRocks / starrocks-connector-for-apache-spark

Apache License 2.0
36 stars 53 forks source link

[Doc] Refactor the documents #66

Closed banmoy closed 1 year ago

banmoy commented 1 year ago

What type of PR is this:

Which issues of this PR fixes :

Fixes #

Problem Summary(Required) :

Currently the documents of connector are maintained in starrocks/docs and docs.zh-cn for english and chinese version respectively. The problem is that we need to submit a PR to each project (total 3 PRs) if there is a change, such as adding a configuration: the code pr for the connector, the two PRs for english and chinese documents, which's cumbersome.

One way to improve the process is integrating the english documents to the connector project, updating the documents when developing the code in one PR, and synchronizing the changes to starrocks official documents in batch when releasing a new version of connector. Keep the chinese document as it is.

Checklist: