[
https://issues.apache.org/jira/browse/BEAM-11693?focusedWorklogId=542522&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-542522
]
ASF GitHub Bot logged work on BEAM-11693:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 27/Jan/21 00:17
Start Date: 27/Jan/21 00:17
Worklog Time Spent: 10m
Work Description: ibzib commented on pull request #13815:
URL: https://github.com/apache/beam/pull/13815#issuecomment-767916507
> Adjust the formatting of the markdown in the release guide to be 1
sentence per line, rather than mix of that, 1 paragraph per line, and 80 char
formatted. This makes reviewing later changes simpler, as new sentences appear
as new lines, changes and removals as one would expect.
The present inconsistency is annoying, but IMO putting each sentence on a
new line decreases the readability of the source in many cases. I'd favor an 80
or 100 character limit since it keeps the paragraph structure visibly intact in
the source, and most importantly a computer can enforce it.
In any case, there should be a website-wide consensus on this, and it should
be checked automatically. Otherwise, it will take a Sisyphean effort to
maintain without much benefit.
----------------------------------------------------------------
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: 542522)
Remaining Estimate: 0h
Time Spent: 10m
> Post 2.26.0 Release Tasks
> -------------------------
>
> Key: BEAM-11693
> URL: https://issues.apache.org/jira/browse/BEAM-11693
> Project: Beam
> Issue Type: Improvement
> Components: project-management, website
> Reporter: Robert Burke
> Assignee: Robert Burke
> Priority: P2
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Umbrella Jira for updates to the release guide based on [~lostluck]'s
> experience releasing 2.26.0.
> # Improve the formatting consistency of the release documentation
> ## Formatting of the markdown version (eg. WRT linebreaks).
> ## Improve readability of sections through bolding highlighting.
> ## Grammar errors and typos.
> # Improve the getting started tasks (be explicit on installed dependencies
> up front. and other environment assumptions).
> # Make the use of arbitrary version numbers consistent / Glossary of
> SCRIPT_SUBSTITUTIONS at the top.
> # Describe the "big picture" of a release to get the manager better situated.
> Anything else while I'm editing that can help.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
