GitHub user caicancai edited a comment on the discussion: Optimization of 
official website documents about streampark

# Streampark documentation V2

# 1. Configure parameter description
![屏幕截图 2023-09-10 
142246](https://github.com/apache/incubator-streampark/assets/77189278/f0eeeada-00b4-4513-8aa4-04d4b9a1ad67)

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

![屏幕截图 2023-09-10 
142858](https://github.com/apache/incubator-streampark/assets/77189278/cedf2d1a-8ba8-4834-b8cb-74baf000400e)
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)

![屏幕截图 2023-09-10 
142858](https://github.com/apache/incubator-streampark/assets/77189278/dbe676fc-420b-462d-a630-4a1ac604b1be)

# 4. Heading style specification
Like DataStream is a subheading of the programming model, so the title of 
DataStream here should be styled in the next level of the programming 

![屏幕截图 2023-09-10 
143344](https://github.com/apache/incubator-streampark/assets/77189278/af90dc51-24fc-4910-add6-8d67dc779790)


# 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

![屏幕截图 2023-09-10 
150822](https://github.com/apache/incubator-streampark/assets/77189278/bd99e25c-8244-430f-a308-8ccab75e433f)

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



GitHub link: 
https://github.com/apache/incubator-streampark/discussions/2962#discussioncomment-6958861

----
This is an automatically sent email for [email protected].
To unsubscribe, please send an email to: [email protected]

Reply via email to