You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by gi...@apache.org on 2021/08/31 00:04:23 UTC
[beam] branch asf-site updated: Publishing website 2021/08/31
00:03:50 at commit bd3649e
This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/asf-site by this push:
new a77efbc Publishing website 2021/08/31 00:03:50 at commit bd3649e
a77efbc is described below
commit a77efbced116815422ce4e1b54392e429f3577c5
Author: jenkins <bu...@apache.org>
AuthorDate: Tue Aug 31 00:03:51 2021 +0000
Publishing website 2021/08/31 00:03:50 at commit bd3649e
---
website/generated-content/contribute/index.xml | 42 ++++++----------------
.../contribute/release-guide/index.html | 20 +++++------
website/generated-content/sitemap.xml | 2 +-
3 files changed, 19 insertions(+), 45 deletions(-)
diff --git a/website/generated-content/contribute/index.xml b/website/generated-content/contribute/index.xml
index 0ede840..76b7e04 100644
--- a/website/generated-content/contribute/index.xml
+++ b/website/generated-content/contribute/index.xml
@@ -345,11 +345,9 @@ limitations under the License.
</li>
<li><a href="#8-prepare-documents">8. Prepare documents</a>
<ul>
-<li><a href="#update-and-verify-javadoc">Update and Verify Javadoc</a></li>
-<li><a href="#build-the-pydoc-api-reference">Build the Pydoc API reference</a></li>
-<li><a href="#propose-pull-requests-for-website-updates">Propose pull requests for website updates</a></li>
-<li><a href="#blog-post">Blog post</a>
+<li><a href="#propose-pull-requests-for-website-updates">Propose pull requests for website updates</a>
<ul>
+<li><a href="#blog-post">Blog post</a></li>
<li><a href="#checklist-to-proceed-to-the-next-step-1">Checklist to proceed to the next step</a></li>
</ul>
</li>
@@ -999,28 +997,6 @@ Carefully review any new artifacts.</li>
<p>See the source of the script for more details or to run commands manually in case of a problem.</p>
<hr>
<h2 id="8-prepare-documents">8. Prepare documents</h2>
-<h3 id="update-and-verify-javadoc">Update and Verify Javadoc</h3>
-<p>The build with <code>-PisRelease</code> creates the combined Javadoc for the release in <code>sdks/java/javadoc</code>.</p>
-<p>The file <code>sdks/java/javadoc/build.gradle</code> contains a list of modules to include and exclude, plus a list of offline URLs that populate links from Beam&rsquo;s Javadoc to the Javadoc for other modules that Beam depends on.</p>
-<ul>
-<li>
-<p>Confirm that new modules added since the last release have been added to the inclusion list as appropriate.</p>
-</li>
-<li>
-<p>Confirm that the excluded package list is up to date.</p>
-</li>
-<li>
-<p>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 <code>&lt;module&gt;-docs/package-list</code> file.</p>
-</li>
-</ul>
-<h3 id="build-the-pydoc-api-reference">Build the Pydoc API reference</h3>
-<p>Make sure you have <code>tox</code> installed:</p>
-<pre><code>pip install tox
-</code></pre><p>Create the Python SDK documentation using sphinx by running a helper script.</p>
-<pre><code>cd sdks/python &amp;&amp; pip install -r build-requirements.txt &amp;&amp; tox -e py37-docs
-</code></pre><p>By default the Pydoc is generated in <code>sdks/python/target/docs/_build</code>.
-Let <code>${PYDOC_ROOT}</code> be the absolute path to <code>_build</code>.</p>
<h3 id="propose-pull-requests-for-website-updates">Propose pull requests for website updates</h3>
<p>Beam publishes API reference manuals for each release on the website.
For Java and Python SDKs, that’s Javadoc and PyDoc, respectively.
@@ -1033,8 +1009,9 @@ A committer can manually trigger the <a href="https://ci-beam.apache.org/job/
<p>This pull request is against the <code>apache/beam-site</code> repo, on the <code>release-docs</code> branch (<a href="https://github.com/apache/beam-site/pull/603">example</a>).
It is created by <code>build_release_candidate.sh</code> (see above).</p>
<p><strong>PR 2: apache/beam</strong></p>
-<p>This pull request is against the <code>apache/beam</code> repo, on the <code>master</code> branch (<a href="https://github.com/apache/beam/pull/11727">example</a>).</p>
+<p>This pull request is against the <code>apache/beam</code> repo, on the <code>master</code> branch (<a href="https://github.com/apache/beam/pull/15068">example</a>).</p>
<ul>
+<li>Update <code>CHANGES.md</code> to update release date and remove template.</li>
<li>Update release version in <code>website/www/site/config.toml</code>.</li>
<li>Add new release in <code>website/www/site/content/en/get-started/downloads.md</code>.
<ul>
@@ -1042,10 +1019,11 @@ It is created by <code>build_release_candidate.sh</code> (see above).</
</ul>
</li>
<li>Update <code>website/www/site/static/.htaccess</code> to redirect to the new version.</li>
+<li>Create the Blog post:</li>
</ul>
-<h3 id="blog-post">Blog post</h3>
+<h4 id="blog-post">Blog post</h4>
<p>Use the template below to write a blog post for the release.
-See <a href="https://github.com/apache/beam/commit/b976e7be0744a32e99c841ad790c54920c8737f5#diff-8b1c3fd0d4a6765c16dfd18509182f9d">beam-2.23.0.md</a> as an example.</p>
+See <a href="https://github.com/apache/beam/commit/a32a75ed0657c122c6625aee1ace27994e7df195#diff-1e2b83a4f61dce8014a1989869b6d31eb3f80cb0d6dade42fb8df5d9407b4748">beam-2.31.0.md</a> as an example.</p>
<ul>
<li>Copy the changes for the current release from <code>CHANGES.md</code> to the blog post and edit as necessary.</li>
<li>Be sure to add yourself to <a href="https://github.com/apache/beam/blob/master/website/www/site/data/authors.yml">authors.yml</a> if necessary.</li>
@@ -1124,9 +1102,9 @@ The complete staging area is available for your review, which includes:
* the official Apache source release to be deployed to dist.apache.org [2], which is signed with the key with fingerprint FFFFFFFF [3],
* all artifacts to be deployed to the Maven Central Repository [4],
* source code tag &quot;v1.2.3-RC3&quot; [5],
-* website pull request listing the release [6], publishing the API reference manual [7], and the blog post [8].
+* website pull request listing the release [6], the blog post [6], and publishing the API reference manual [7].
* Java artifacts were built with Maven MAVEN_VERSION and OpenJDK/Oracle JDK JDK_VERSION.
-* Python artifacts are deployed along with the source release to the dist.apache.org [2].
+* Python artifacts are deployed along with the source release to the dist.apache.org [2] and pypy[8].
* Validation sheet with a tab for 1.2.3 release to help with validation [9].
* Docker images published to Docker Hub [10].
The vote will be open for at least 72 hours. It is adopted by majority approval, with at least 3 PMC affirmative votes.
@@ -1140,7 +1118,7 @@ Release Manager
[5] https://github.com/apache/beam/tree/v1.2.3-RC3
[6] https://github.com/apache/beam/pull/...
[7] https://github.com/apache/beam-site/pull/...
-[8] https://github.com/apache/beam/pull/...
+[8] https://pypi.org/project/apache-beam/1.2.3rc3/
[9] https://docs.google.com/spreadsheets/d/1qk-N5vjXvbcEk68GjbkSZTR8AGqyNUM-oLFo_ZXBpJw/edit#gid=...
[10] https://hub.docker.com/search?q=apache%2Fbeam&amp;type=image
</code></pre>
diff --git a/website/generated-content/contribute/release-guide/index.html b/website/generated-content/contribute/release-guide/index.html
index 3cc1af4..e5a67d6 100644
--- a/website/generated-content/contribute/release-guide/index.html
+++ b/website/generated-content/contribute/release-guide/index.html
@@ -18,7 +18,7 @@
function addPlaceholder(){$('input:text').attr('placeholder',"What are you looking for?");}
function endSearch(){var search=document.querySelector(".searchBar");search.classList.add("disappear");var icons=document.querySelector("#iconsBar");icons.classList.remove("disappear");}
function blockScroll(){$("body").toggleClass("fixedPosition");}
-function openMenu(){addPlaceholder();blockScroll();}</script><div class="clearfix container-main-content"><div class="section-nav closed" data-offset-top=90 data-offset-bottom=500><span class="section-nav-back glyphicon glyphicon-menu-left"></span><nav><ul class=section-nav-list data-section-nav><li><span class=section-nav-list-main-title>Contribute</span></li><li><a href=/contribute/>Get started contributing</a></li><li><a href=/contribute/get-help/>Get Help</a></li><li><a href=/contrib [...]
+function openMenu(){addPlaceholder();blockScroll();}</script><div class="clearfix container-main-content"><div class="section-nav closed" data-offset-top=90 data-offset-bottom=500><span class="section-nav-back glyphicon glyphicon-menu-left"></span><nav><ul class=section-nav-list data-section-nav><li><span class=section-nav-list-main-title>Contribute</span></li><li><a href=/contribute/>Get started contributing</a></li><li><a href=/contribute/get-help/>Get Help</a></li><li><a href=/contrib [...]
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.</p><p>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.</p><p>Each release is executed by a <em>Release Manager</em>, who is selected among the Beam committers.
@@ -161,18 +161,14 @@ Carefully review any new artifacts.</li></ol></li></ol><h3 id=upload-release-can
--rc "${RC_NUM}" \
--user "${GITHUB_USER}" \
--deploy
-</code></pre></li><li><p><strong>The script will:</strong></p><ol><li>Download python binary artifacts</li><li>Deploy release candidate to PyPI</li></ol></li></ul><p><strong>Attention:</strong> Verify that:</p><ul><li>The File names version include <code>rc-#</code> suffix</li><li><a href=https://pypi.org/project/apache-beam/#files>Download Files</a> have:<ul><li>All wheels uploaded as artifacts</li><li>Release source’s zip published</li><li>Signatures and hashes do not need to be [...]
-If the version number has changed, download a new version of the corresponding <code><module>-docs/package-list</code> file.</p></li></ul><h3 id=build-the-pydoc-api-reference>Build the Pydoc API reference</h3><p>Make sure you have <code>tox</code> installed:</p><pre><code>pip install tox
-</code></pre><p>Create the Python SDK documentation using sphinx by running a helper script.</p><pre><code>cd sdks/python && pip install -r build-requirements.txt && tox -e py37-docs
-</code></pre><p>By default the Pydoc is generated in <code>sdks/python/target/docs/_build</code>.
-Let <code>${PYDOC_ROOT}</code> be the absolute path to <code>_build</code>.</p><h3 id=propose-pull-requests-for-website-updates>Propose pull requests for website updates</h3><p>Beam publishes API reference manuals for each release on the website.
+</code></pre></li><li><p><strong>The script will:</strong></p><ol><li>Download python binary artifacts</li><li>Deploy release candidate to PyPI</li></ol></li></ul><p><strong>Attention:</strong> Verify that:</p><ul><li>The File names version include <code>rc-#</code> suffix</li><li><a href=https://pypi.org/project/apache-beam/#files>Download Files</a> have:<ul><li>All wheels uploaded as artifacts</li><li>Release source’s zip published</li><li>Signatures and hashes do not need to be [...]
For Java and Python SDKs, that’s Javadoc and PyDoc, respectively.
The final step of building the candidate is to propose website pull requests that update these manuals.</p><p>Merge the pull requests only after finalizing the release.
To avoid invalid redirects for the ‘current’ version, merge these PRs in the order listed.
Once the PR is merged, the new contents will get picked up automatically and served to the Beam website, usually within an hour.
A committer can manually trigger the <a href=https://ci-beam.apache.org/job/beam_PostCommit_Website_Publish/>beam_PostCommit_Website_Publish</a> task in Jenkins to avoid waiting.</p><p><strong>PR 1: apache/beam-site</strong></p><p>This pull request is against the <code>apache/beam-site</code> repo, on the <code>release-docs</code> branch (<a href=https://github.com/apache/beam-site/pull/603>example</a>).
-It is created by <code>build_release_candidate.sh</code> (see above).</p><p><strong>PR 2: apache/beam</strong></p><p>This pull request is against the <code>apache/beam</code> repo, on the <code>master</code> branch (<a href=https://github.com/apache/beam/pull/11727>example</a>).</p><ul><li>Update release version in <code>website/www/site/config.toml</code>.</li><li>Add new release in <code>website/www/site/content/en/get-started/downloads.md</code>.<ul><li>Download links will not work un [...]
-See <a href=https://github.com/apache/beam/commit/b976e7be0744a32e99c841ad790c54920c8737f5#diff-8b1c3fd0d4a6765c16dfd18509182f9d>beam-2.23.0.md</a> as an example.</p><ul><li>Copy the changes for the current release from <code>CHANGES.md</code> to the blog post and edit as necessary.</li><li>Be sure to add yourself to <a href=https://github.com/apache/beam/blob/master/website/www/site/data/authors.yml>authors.yml</a> if necessary.</li></ul><p><strong>Tip</strong>: Use git log to find cont [...]
+It is created by <code>build_release_candidate.sh</code> (see above).</p><p><strong>PR 2: apache/beam</strong></p><p>This pull request is against the <code>apache/beam</code> repo, on the <code>master</code> branch (<a href=https://github.com/apache/beam/pull/15068>example</a>).</p><ul><li>Update <code>CHANGES.md</code> to update release date and remove template.</li><li>Update release version in <code>website/www/site/config.toml</code>.</li><li>Add new release in <code>website/www/site [...]
+See <a href=https://github.com/apache/beam/commit/a32a75ed0657c122c6625aee1ace27994e7df195#diff-1e2b83a4f61dce8014a1989869b6d31eb3f80cb0d6dade42fb8df5d9407b4748>beam-2.31.0.md</a> as an example.</p><ul><li>Copy the changes for the current release from <code>CHANGES.md</code> to the blog post and edit as necessary.</li><li>Be sure to add yourself to <a href=https://github.com/apache/beam/blob/master/website/www/site/data/authors.yml>authors.yml</a> if necessary.</li></ul><p><strong>Tip</s [...]
Make sure to clean it up, as there may be duplicate or incorrect user names.</p><p><strong>NOTE</strong>: Make sure to include any breaking changes, even to <code>@Experimental</code> features,
all major features and bug fixes, and all known issues.</p><p><strong>Template:</strong></p><pre><code>We are happy to present the new {$RELEASE_VERSION} release of Beam.
This release includes both improvements and new functionality.
@@ -245,9 +241,9 @@ The complete staging area is available for your review, which includes:
* the official Apache source release to be deployed to dist.apache.org [2], which is signed with the key with fingerprint FFFFFFFF [3],
* all artifacts to be deployed to the Maven Central Repository [4],
* source code tag "v1.2.3-RC3" [5],
-* website pull request listing the release [6], publishing the API reference manual [7], and the blog post [8].
+* website pull request listing the release [6], the blog post [6], and publishing the API reference manual [7].
* Java artifacts were built with Maven MAVEN_VERSION and OpenJDK/Oracle JDK JDK_VERSION.
-* Python artifacts are deployed along with the source release to the dist.apache.org [2].
+* Python artifacts are deployed along with the source release to the dist.apache.org [2] and pypy[8].
* Validation sheet with a tab for 1.2.3 release to help with validation [9].
* Docker images published to Docker Hub [10].
@@ -265,7 +261,7 @@ Release Manager
[5] https://github.com/apache/beam/tree/v1.2.3-RC3
[6] https://github.com/apache/beam/pull/...
[7] https://github.com/apache/beam-site/pull/...
-[8] https://github.com/apache/beam/pull/...
+[8] https://pypi.org/project/apache-beam/1.2.3rc3/
[9] https://docs.google.com/spreadsheets/d/1qk-N5vjXvbcEk68GjbkSZTR8AGqyNUM-oLFo_ZXBpJw/edit#gid=...
[10] https://hub.docker.com/search?q=apache%2Fbeam&type=image
</code></pre><p>If there are any issues found in the release candidate, reply on the vote thread to cancel the vote.
@@ -413,7 +409,7 @@ If you end up getting permissions errors ask on the mailing list for assistance.
Ask other contributors to do the same.</p><p>Also, update <a href=https://en.wikipedia.org/wiki/Apache_Beam>the Wikipedia article on Apache Beam</a>.</p><h3 id=checklist-to-declare-the-process-completed>Checklist to declare the process completed</h3><ol><li>Release announced on the user@ mailing list.</li><li>Blog post published, if applicable.</li><li>Release recorded in reporter.apache.org.</li><li>Release announced on social media.</li><li>Completion declared on the dev@ mailing list. [...]
Once you’ve finished the release, please take a step back and look what areas of this process and be improved. Perhaps some part of the process can be simplified.
Perhaps parts of this guide can be clarified.</p><p>If we have specific ideas, please start a discussion on the dev@ mailing list and/or propose a pull request to update this guide.
-Thanks!</p><div class=feedback><p class=update>Last updated on 2021/06/09</p><h3>Have you found everything you were looking for?</h3><p class=description>Was it all useful and clear? Is there anything that you would like to change? Let us know!</p><button class=load-button><a href="mailto:dev@beam.apache.org?subject=Beam Website Feedback">SEND FEEDBACK</a></button></div></div></div><footer class=footer><div class=footer__contained><div class=footer__cols><div class="footer__cols__col foo [...]
+Thanks!</p><div class=feedback><p class=update>Last updated on 2021/07/08</p><h3>Have you found everything you were looking for?</h3><p class=description>Was it all useful and clear? Is there anything that you would like to change? Let us know!</p><button class=load-button><a href="mailto:dev@beam.apache.org?subject=Beam Website Feedback">SEND FEEDBACK</a></button></div></div></div><footer class=footer><div class=footer__contained><div class=footer__cols><div class="footer__cols__col foo [...]
<a href=http://www.apache.org>The Apache Software Foundation</a>
| <a href=/privacy_policy>Privacy Policy</a>
| <a href=/feed.xml>RSS Feed</a><br><br>Apache Beam, Apache, Beam, the Beam logo, and the Apache feather logo are either registered trademarks or trademarks of The Apache Software Foundation. All other products or name brands are trademarks of their respective holders, including The Apache Software Foundation.</div></div></div></div></footer></body></html>
\ No newline at end of file
diff --git a/website/generated-content/sitemap.xml b/website/generated-content/sitemap.xml
index 20db569..0689eb2 100644
--- a/website/generated-content/sitemap.xml
+++ b/website/generated-content/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/blog/beam-2.32.0/</loc><lastmod>2021-08-26T11:29:05-07:00</lastmod></url><url><loc>/categories/blog/</loc><lastmod>2021-08-26T11:29:05-07:00</lastmod></url><url><loc>/blog/</loc><lastmod>2021-08-26T11:29:05-07:00</lastmod></url><url><loc>/categories/</loc><lastmod>2021-08-26T11:29:05-07:00</lastmod></url><url><loc>/blog/b [...]
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml"><url><loc>/blog/beam-2.32.0/</loc><lastmod>2021-08-26T11:29:05-07:00</lastmod></url><url><loc>/categories/blog/</loc><lastmod>2021-08-26T11:29:05-07:00</lastmod></url><url><loc>/blog/</loc><lastmod>2021-08-26T11:29:05-07:00</lastmod></url><url><loc>/categories/</loc><lastmod>2021-08-26T11:29:05-07:00</lastmod></url><url><loc>/blog/b [...]
\ No newline at end of file