kennknowles commented on code in PR #28619:
URL: https://github.com/apache/beam/pull/28619#discussion_r1334725071
##########
contributor-docs/release-guide.md:
##########
@@ -17,44 +14,49 @@ limitations under the License.
# Apache Beam Release Guide
-{{< toc >}}
-
## Introduction
-The Apache Beam project periodically declares and publishes releases.
-A release is one or more packages of the project artifact(s) that are approved
for general public distribution and use.
-They may come with various degrees of caveat regarding their perceived quality
and potential for change, such as “alpha”, “beta”, “incubating”, “stable”, etc.
+The Apache Beam project periodically declares and publishes releases. A
+release is one or more packages of the project artifact(s) that are approved
+for general public distribution and use. They may come with various degrees of
+caveat regarding their perceived quality and potential for change, such as
+“alpha”, “beta”, “incubating”, “stable”, etc.
-The Beam community treats releases with great importance.
-They are a public face of the project and most users interact with the project
only through the releases. Releases are signed off by the entire Beam community
in a public vote.
+The Beam community treats releases with great importance. They are a public
+face of the project and most users interact with the project only through the
+releases. Releases are signed off by the entire Beam community in a public
+vote.
-Each release is executed by a *Release Manager*, who is selected among the
Beam committers.
-This document describes the process that the Release Manager follows to
perform a release.
-Any changes to this process should be discussed and adopted on the [dev@
mailing list](/get-started/support/).
+Each release is executed by a *Release Manager*, who is selected among the Beam
+committers. This document describes the process that the Release Manager
+follows to perform a release. Any changes to this process should be discussed
+and adopted on the [dev@ mailing list](/get-started/support/).
-Please remember that publishing software has legal consequences.
-This guide complements the foundation-wide [Product Release
Policy](https://www.apache.org/dev/release.html) and [Release Distribution
Policy](https://www.apache.org/dev/release-distribution).
+Please remember that publishing software has legal consequences. This guide
+complements the foundation-wide [Product Release
+Policy](https://www.apache.org/dev/release.html) and [Release Distribution
+Policy](https://www.apache.org/dev/release-distribution).
### Overview
-<img src="/images/release-guide-1.png" alt="Release step flow chart"
width="100%">
+<img src="images/release-guide-1.png" alt="Release step flow chart"
width="100%">
The release process consists of several steps:
1. Decide to release
-1. Prepare for the release
-1. Build a release candidate
- 1. Create a release branch
- 1. Verify release branch
- 1. Tag a release candidate
- 1. Build release artifacts
-1. Vote on the release candidate
- * During vote process, run validation tests
-1. If necessary, fix any issues and go back to step 3.
-1. Finalize the release
-1. Promote the release
-
-**********
+2. Prepare for the release
+3. Build a release candidate
+ 1. Create a release branch
+ 2. Verify release branch
+ 3. Tag a release candidate
+ 4. Build release artifacts
+4. Vote on the release candidate
+ * During vote process, run validation tests
+5. If necessary, fix any issues and go back to step 3.
+6. Finalize the release
+7. Promote the release
Review Comment:
I think the main axiom that is opinion-driven is whether _this_ markdown
file is to be a text format or just source for a rendering. And given a
population of people on both sides of that, which we obviously have, the next
opinion-driven decision is whether to accommodate both or not.
As a text format, the question of "long enough to switch to lazy numbering
is moot. A list of `1.` is not a numbered list. It just has a clunky bullet.
This list can just be made better instead:
- it has a reference "go back to step 3" that would not refer to anything
if there is no "3". TBH that could just be clearer with words, so I switched it.
- it has an extraneous nested list which is also numbered, super gross and
even rendered that way by our website (GitHub does better)
- the outer and inner nested lists are both incorrect!
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
