[ 
https://issues.apache.org/jira/browse/FLINK-33235?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17774452#comment-17774452
 ] 

xiangyu feng edited comment on FLINK-33235 at 10/12/23 11:37 AM:
-----------------------------------------------------------------

[~martijnvisser] Hi Martjin, thx for your comment. I see your point now and I 
agree with you on this. However, I still want to improve this doc in following 
ways:

1, After checking the 
[https://flink.apache.org/how-to-contribute/documentation-style-guide/,|https://flink.apache.org/how-to-contribute/documentation-style-guide/]
 we should use 'active voice' and 'you'  instead of 'passive voice' and 'we' in 
the doc;

2, Add architecture graphs in this doc;

3, Fix typos and misconfigured options in this doc;

4, Add notes to explain that some OLAP features may have not released yet, user 
can choose to build from the master branch;

I will change the tittle and description accordingly, WDYT?

 


was (Author: JIRAUSER301129):
[~martijnvisser] Hi Martjin, thx for your comment. I see your point now and I 
agree with you on this. However, I still want to improve this doc in following 
ways:

1, After checking the [Documentation 
Guide|[https://flink.apache.org/how-to-contribute/documentation-style-guide/],] 
we should use 'active voice' and 'you'  instead of 'passive voice' and 'we' in 
the doc;

2, Add architecture graphs in this doc;

3, Fix typos and misconfigured options in this doc;

4, Add notes to explain that some OLAP features may have not released yet, user 
can choose to build from the master branch;

I will change the tittle and description accordingly, WDYT?

 

> Improve the Quickstart guide for Flink OLAP
> -------------------------------------------
>
>                 Key: FLINK-33235
>                 URL: https://issues.apache.org/jira/browse/FLINK-33235
>             Project: Flink
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: xiangyu feng
>            Assignee: xiangyu feng
>            Priority: Major
>
> 1, Follow the [Documentation 
> Guide|[https://flink.apache.org/how-to-contribute/documentation-style-guide/]],
>  use 'active voice' and 'you' instead of 'passive voice' and 'we' in the doc;
> 2, Add architecture graphs in the doc;
> 3, Fix typos and misconfigured options in the doc;
> 4, Add notes to explain that some OLAP features may have not been released 
> yet, user can choose to build from the master branch;



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to