beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dhalp...@apache.org
Subject [3/4] beam-site git commit: Minor tweaks
Date Wed, 22 Feb 2017 20:25:48 GMT
Minor tweaks


Project: http://git-wip-us.apache.org/repos/asf/beam-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/beam-site/commit/28e1b597
Tree: http://git-wip-us.apache.org/repos/asf/beam-site/tree/28e1b597
Diff: http://git-wip-us.apache.org/repos/asf/beam-site/diff/28e1b597

Branch: refs/heads/asf-site
Commit: 28e1b59727a48f482e7806cbb63db307adf4f049
Parents: 2d661f9
Author: Dan Halperin <dhalperi@google.com>
Authored: Wed Feb 22 12:14:50 2017 -0800
Committer: Dan Halperin <dhalperi@google.com>
Committed: Wed Feb 22 12:14:50 2017 -0800

----------------------------------------------------------------------
 src/contribute/release-guide.md | 29 +++++++++++++----------------
 1 file changed, 13 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/beam-site/blob/28e1b597/src/contribute/release-guide.md
----------------------------------------------------------------------
diff --git a/src/contribute/release-guide.md b/src/contribute/release-guide.md
index 3e56a85..7bba5ee 100644
--- a/src/contribute/release-guide.md
+++ b/src/contribute/release-guide.md
@@ -157,23 +157,20 @@ profile are in good shape.
 
 ### Update and Verify Javadoc
 
-The build with `-Prelease` creates the combined javadoc for the release in `sdks/java/javadoc`.
+The build with `-Prelease` creates the combined Javadoc for the release in `sdks/java/javadoc`.
 
-In that directory, the file `sdks/java/javadoc/ant.xml` file contains a list of
-modules to include in and exclude, plus a list of offline URLs that populate
-links to Javadoc for other modules that Beam depends on.
+The file `sdks/java/javadoc/ant.xml` file contains a list of modules to include
+in and exclude, plus a list of offline URLs that populate links from Beam's
+Javadoc to the Javadoc for other modules that Beam depends on.
 
-You should both examine the generated javadoc and look over the contents of that
-file to ensure that the javadoc is correct.
+* Confirm that new modules added since the last release have been added to the
+  inclusion list as appropriate.
 
-Confirm that new modules added since the last release have been added to the
-inclusion list as appropriate.
+* Confirm that the excluded package list is up to date.
 
-Confirm that the excluded package list is up to date.
-
-Verify the version numbers for offline links match the versions used by Beam. If
-the version number has changed, download a new version of the corresponding
-XX-docs/package-list file.
+* Verify the version numbers for offline links match the versions used by Beam. If
+  the version number has changed, download a new version of the corresponding
+  `<module>-docs/package-list` file.
 
 ### Create a release branch
 
@@ -289,9 +286,9 @@ Start by updating `release_latest` version flag in the top-level `_config.yml`,
 
 Beam publishes API reference manual for each release on the website. For Java SDK, that’s
Javadoc.
 
-One of the artifacts created in the release contains the Javadoc for the website: 
-. To update the website, you must unpack
-this jar file from the release candidate into the source tree of the website.
+One of the artifacts created in the release contains the Javadoc for the
+website. To update the website, you must unpack this jar file from the release
+candidate into the source tree of the website.
 
 Add the new Javadoc to [SDK API Reference page]({{ site.baseurl }}/documentation/sdks/javadoc/)
page, as follows:
 


Mime
View raw message