incubator-streampark icon indicating copy to clipboard operation
incubator-streampark copied to clipboard

[Feature] Better document management

Open LiebingYu opened this issue 3 years ago • 1 comments

Search before asking

  • [X] I had searched in the feature and found no similar feature requirement.

Description

There are a few issues with current document management for StreamPark users and people who want to contribute code:

  1. Currently StreamPark does not have versioned document management, only the latest version of the document. This can cause confusion and problems for users. For example, a user may use an older stable version, but he can only see the latest document, not the corresponding version

  2. At present, StreamPark's documentation and code are managed separately, which makes it difficult for developers to directly modify the corresponding documentation after contributing relevant code. It also does not facilitate unified Git management of code and documentation

Usage Scenario

Document reading and management.

Related issues

No.

Are you willing to submit a PR?

  • [X] Yes I am willing to submit a PR!

Code of Conduct

LiebingYu avatar Sep 30 '22 09:09 LiebingYu

Thanks for your feedback, this is the next work we have to do, you are very welcome to join in, we will solve this issue together

wolfboys avatar Oct 02 '22 15:10 wolfboys