Myasuka commented on a change in pull request #8272: [FLINK-12274] Fix
documentation to enable Queryable State
URL: https://github.com/apache/flink/pull/8272#discussion_r279677178
##########
File path: docs/dev/stream/state/queryable_state.md
##########
@@ -69,10 +69,12 @@ response back to the client.
## Activating Queryable State
-To enable queryable state on your Flink cluster, you just have to copy the
-`flink-queryable-state-runtime{{ site.scala_version_suffix }}-{{site.version
}}.jar`
+To enable queryable state on your Flink cluster, you need to do the following:
+
+ 1. copy the `flink-queryable-state-runtime{{ site.scala_version_suffix
}}-{{site.version }}.jar`
from the `opt/` folder of your [Flink
distribution](https://flink.apache.org/downloads.html "Apache Flink:
Downloads"),
-to the `lib/` folder. Otherwise, the queryable state feature is not enabled.
+to the `lib/` folder.
+ 2. set the property `queryable-state.enable` to `true` in
`./conf/flink-conf.yaml`. See the [Configuration]({{ site.baseurl
}}/ops/config.html#queryable-state) documentation for details and additional
parameters.
Review comment:
In my mind, "set the property `queryable-state.enable` to `true` in
`./conf/flink-conf.yaml`" might give user a subconscious hint that we could
only change properties by editing the `./conf/flink-conf.yaml`. Actually, we
could change related properties through other ways such as `-yD
<property=value>` when submitting jobs in YARN.
In other words, I think describe this by only speaking of "set the property
`queryable-state.enable` to `true`" should be enough.
Last but not least, this is a just a `comment` not a `request change` from a
non-native English speaker understanding.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
