[
https://issues.apache.org/jira/browse/BEAM-8996?focusedWorklogId=365912&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-365912
]
ASF GitHub Bot logged work on BEAM-8996:
----------------------------------------
Author: ASF GitHub Bot
Created on: 03/Jan/20 17:35
Start Date: 03/Jan/20 17:35
Worklog Time Spent: 10m
Work Description: mxm commented on issue #10424: [BEAM-8996]
Auto-generate pipeline options documentation for FlinkRunner
URL: https://github.com/apache/beam/pull/10424#issuecomment-570634769
PRs are a means to have a second pair of eyes. An approval is not strictly
necessary when a change provides an improvement or feature which is undoubtedly
useful or necessary for the success of the project.
Last time I checked we had close to 200 open pull requests. One reason is
that there are simply not enough people reviewing pull requests. Another reason
is that the conversation in the PRs progressively slows down because of
questions, requests, wishes, or nitpicks. I know some people who have given up
contributing to Beam because of too much wishful thinking in the conversations.
That is not to say that those comments are not valid, but there is a trade off
between in the dimensions of time, complexity, and maintenance that should be
carefully thought about when reviewing PRs.
I always consider all the comments I receive, but I'm only willing to
compromise my time to a degree. If a suggestion does not convince me or it
simply does not provide enough benefit for the time and mental energy it would
to take to implement it, I won't incorporate it, but reject it politely.
The feature here has already at least twice led to an updated documentation.
It works flawlessly and I'm more than happy to see it being improved,
generalized, extended to use templating, or xyz. I'm just not going to do this
myself at the moment because I would like to focus my mental energy on other
work.
Contributing to Beam should be as hard as necessary but not any harder.
Edit: The paragraphs somehow do not show up correctly in the mobile
version...
----------------------------------------------------------------
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: 365912)
Time Spent: 4.5h (was: 4h 20m)
> 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
> Fix For: 2.19.0
>
> Time Spent: 4.5h
> 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)
