[Doc] Refactor the documents #66
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
| This Connector can support reading data stored in StarRocks through Apache Spark™. | ||
| # StarRocks Connector for Apache Spark™ | ||
|
|
||
| The connector supports to read from and write to StarRocks through Apache Spark™. | ||
|
|
||
| ## Upstream |
There was a problem hiding this comment.
why mention doris here?
There was a problem hiding this comment.
The ability of reading from starrocks refers to doris-spark-connector
Signed-off-by: PengFei Li <lpengfei2016@gmail.com>
Signed-off-by: PengFei Li <lpengfei2016@gmail.com>
Signed-off-by: PengFei Li <lpengfei2016@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: