apache / incubator-streampark

Make stream processing easier! Easy-to-use streaming application development framework and operation platform.
https://streampark.apache.org/
Apache License 2.0
3.86k stars 996 forks source link

[Feature] Better document management #1724

Open LB-Yu opened 2 years ago

LB-Yu commented 2 years ago

Search before asking

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?

Code of Conduct

wolfboys commented 2 years ago

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