[
https://issues.apache.org/jira/browse/BEAM-8996?focusedWorklogId=361598&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-361598
]
ASF GitHub Bot logged work on BEAM-8996:
----------------------------------------
Author: ASF GitHub Bot
Created on: 20/Dec/19 11:20
Start Date: 20/Dec/19 11:20
Worklog Time Spent: 10m
Work Description: lgajowy commented on pull request #10424: [BEAM-8996]
Auto-generate pipeline options documentation for FlinkRunner
URL: https://github.com/apache/beam/pull/10424#discussion_r360311866
##########
File path: runners/flink/flink_runner.gradle
##########
@@ -225,3 +225,29 @@ tasks.register('validatesRunner') {
// Generates :runners:flink:1.9:runQuickstartJavaFlinkLocal
createJavaExamplesArchetypeValidationTask(type: 'Quickstart', runner:
'FlinkLocal')
+
+/**
+ * Updates the documentation with the current pipeline options.
+ */
+def createPipelineOptionsTableTask(String target) {
+ tasks.register("generatePipelineOptionsTable${target}", JavaExec) {
+ group = 'Website'
+ description = "Generates the HTML table for the Flink Runner page"
Review comment:
Can we change this to: "Generates a table with pipeline options for the
Flink Runner documentation page" to be even more descriptive?
----------------------------------------------------------------
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]
Issue Time Tracking
-------------------
Worklog Id: (was: 361598)
Time Spent: 50m (was: 40m)
> Auto-generate pipeline options documentation for FlinkRunner
> ------------------------------------------------------------
>
> Key: BEAM-8996
> URL: https://issues.apache.org/jira/browse/BEAM-8996
> Project: Beam
> Issue Type: Improvement
> Components: runner-flink
> Reporter: Maximilian Michels
> Assignee: Maximilian Michels
> Priority: Major
> Time Spent: 50m
> Remaining Estimate: 0h
>
> The documentation on the pipeline options on the [runner
> page|https://beam.apache.org/documentation/runners/flink/] easily becomes
> outdated. In order for them to stay up to date, we should auto-generate the
> documentation from the {{FlinkPipelineOptions}} class. This should be done
> for both Java and Python.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
