Optimization of official website documents about streampark

[caicancai]

There are still many places that can be optimized in the streampark official document, which can be summarized and then evaluated and optimized together.

[caicancai]

Some parameter configurations do not correspond to the source code

[caicancai]

done

[caicancai]

Streampark documentation V2

1. Configure parameter description

For example, the current kubernetes_V2 module executing in streampark, flinkversion must be in the form of 1.17.1/1.17, if the 17.1 form may report an error

2. Image update

For previous StreamX style images, consider updating the StreamPark style

There are also some service configuration pictures that do not match the current interface

3. Complete description of the steps

For example, add LDAP configuration here, there are two steps here, in fact, you can add a third step here, and then use it as usual (directly start) or something, so as not to cause ambiguity to the user (such as the document is not finished)

4. Heading style specification

5. K8S document and Hadoop document optimization

Now the Kubernetes documentation and Hadoop documentation are relatively simple and can be more detailed

For example, K8S documents can be described by Appliction, Session, and Cluster respectively, for example, to configure Session, you need to configure cluster first

I think it is good to make it clear about task publishing, task recovery, and task parameter configuration in the corresponding K8S document or Hadoop document, and there is no need to write a new document

6. Some Chinese documents do not match the English documents

Here I think it is better to follow the English document

7. Normalization of proper nouns

For example, Some proper nouns such as 火花图 do not have to be translated into Chinese

8.What is Streampark document optimization

The framework introduction adds a usage scenario description to let users understand what problems StreamPark can solve

[caicancai]

@wolfboys

[wolfboys]

Thank you for your collection and feedback. These areas have all been adjusted and optimized. 👍 BTW, The features of k8sV2 are still work in progress. The documentation can be prepared now. Our goal is for v2 to replace the implementation of v1, including the documentation. They will coexist for a period of time until v2 becomes stable.

[caicancai]

get

[Kick156]

I feel like we should add a versioning button to the document.

[caicancai]

I think this is actually not necessary unless there are major changes between versions, and the number of streampark versions is indeed not many. There are more subsequent versions, so I think it can be considered. Of course, this is just my opinion. I'd love to hear your opinion, bro.

[Kick156]

 Hi bro. Once I forgot how to do it when deploying a new version, and I wanted to see the documentation on the official website, but the documentation disappeared. I found it in the web project through GitHub during the discussion. So why can't it be solved by one-click version switching?
 Strictly speaking, Dinky, also as a streaming data development platform, has clear version management in its documentation, and it is not yet an Apache project, shouldn't we, as a project that entered the Apache incubator, do a better job in this regard.
 Of course, this is just my personal idea, and it is okay if you don't get it for the time being.

[wolfboys]

In versions prior to 2.0 of StreamX, We not necessary to provide documentation. We can offer multi-version documentation support for major releases. For example, 2.0.0 and the upcoming 2.2.

[caicancai]

Supplemental contributor documentation

[caicancai]

done