You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by sc...@apache.org on 2018/10/11 16:39:55 UTC
[beam] 08/11: Publishing website 2018/10/05 22:39:21 at commit
a19183b
This is an automated email from the ASF dual-hosted git repository.
scott pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam.git
commit 444a308b8d368eb1e30b4d6031df6797a22f75dc
Author: jenkins <bu...@apache.org>
AuthorDate: Fri Oct 5 22:39:21 2018 +0000
Publishing website 2018/10/05 22:39:21 at commit a19183b
---
website/generated-content/.htaccess | 2 +-
website/generated-content/contribute/index.html | 10 +-
.../contribute/release-guide/index.html | 92 +++--
.../contribute/website-contributions/index.html | 369 ---------------------
4 files changed, 65 insertions(+), 408 deletions(-)
diff --git a/website/generated-content/.htaccess b/website/generated-content/.htaccess
index b36da9e..82e9c99 100644
--- a/website/generated-content/.htaccess
+++ b/website/generated-content/.htaccess
@@ -19,6 +19,6 @@ RewriteRule ^(.*)$ https://beam.apache.org/$1 [L,R=301]
# They were previously hosted within this repository, and published at the URL
# path /documentation/sdks/(javadoc|pydoc)/..
# The following redirect maintains the previously supported URLs.
-RedirectMatch permanent "/documentation/sdks/(javadoc|pydoc)(.*)" "https://beam.apache.org/documentation/releases/$1$2"
+RedirectMatch permanent "/documentation/sdks/(javadoc|pydoc)(.*)" "https://beam.apache.org/releases/$1$2"
# Keep this updated to point to the current release.
RedirectMatch "/releases/([^/]+)/current(.*)" "https://beam.apache.org/releases/$1/2.6.0$2"
diff --git a/website/generated-content/contribute/index.html b/website/generated-content/contribute/index.html
index 9c8cb3c..094b4c0 100644
--- a/website/generated-content/contribute/index.html
+++ b/website/generated-content/contribute/index.html
@@ -530,12 +530,10 @@ a read-only collaborator to apache/beam by opening an INFRA ticket. -->
<h2 id="contributing-to-the-website">Contributing to the website</h2>
-<p>The Beam website is in the <a href="https://github.com/apache/beam-site">Beam Site GitHub
-mirror</a> repository in the <code class="highlighter-rouge">asf-site</code>
-branch (<em>not</em> <code class="highlighter-rouge">master</code>). The
-<a href="https://github.com/apache/beam-site/blob/asf-site/README.md">README</a> there
-explains how to modify different parts of the site. The GitHub workflow is the
-same - make your change and open a pull request.</p>
+<p>The Beam website is in the <code class="highlighter-rouge">/website</code> directory of the repo. The
+<a href="https://github.com/apache/beam/blob/master/website">README</a> there explains how
+to modify different parts of the site. The GitHub workflow is the same - make
+your change and open a pull request.</p>
<p>Issues are tracked in the
<a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20BEAM%20AND%20component%20%3D%20website">website</a>
diff --git a/website/generated-content/contribute/release-guide/index.html b/website/generated-content/contribute/release-guide/index.html
index 6486976..965fdb4 100644
--- a/website/generated-content/contribute/release-guide/index.html
+++ b/website/generated-content/contribute/release-guide/index.html
@@ -327,10 +327,7 @@ limitations under the License.
<li><a href="#stage-source-release-on-distapacheorg" id="markdown-toc-stage-source-release-on-distapacheorg">Stage source release on dist.apache.org</a></li>
<li><a href="#stage-python-binaries-on-distapacheorg" id="markdown-toc-stage-python-binaries-on-distapacheorg">Stage python binaries on dist.apache.org</a></li>
<li><a href="#build-the-pydoc-api-reference" id="markdown-toc-build-the-pydoc-api-reference">Build the Pydoc API reference</a></li>
- <li><a href="#propose-a-pull-request-for-website-updates" id="markdown-toc-propose-a-pull-request-for-website-updates">Propose a pull request for website updates</a> <ul>
- <li><a href="#create-pydoc" id="markdown-toc-create-pydoc">Create Pydoc</a></li>
- </ul>
- </li>
+ <li><a href="#propose-pull-requests-for-website-updates" id="markdown-toc-propose-pull-requests-for-website-updates">Propose pull requests for website updates</a></li>
<li><a href="#build-and-stage-python-wheels" id="markdown-toc-build-and-stage-python-wheels">Build and stage python wheels</a></li>
<li><a href="#checklist-to-proceed-to-the-next-step-2" id="markdown-toc-checklist-to-proceed-to-the-next-step-2">Checklist to proceed to the next step</a></li>
</ul>
@@ -556,8 +553,26 @@ please submit your GPG public key into <a href="http://pgp.mit.edu:11371/">MIT P
<h4 id="website-development-setup">Website development setup</h4>
-<p>Prepare to update the Beam website by following the <a href="/contribute/website-contributions/">website development
-instructions</a>.</p>
+<p>Updating the Beam website requires submitting PRs to both the main <code class="highlighter-rouge">apache/beam</code>
+repo and the <code class="highlighter-rouge">apache/beam-site</code> repo. The first contains reference manuals
+generated from SDK code, while the second updates the current release version
+number.</p>
+
+<p>You should already have setup a local clone of <code class="highlighter-rouge">apache/beam</code>. Setting up a clone
+of <code class="highlighter-rouge">apache/beam-site</code> is similar:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>$ git clone -b release-docs https://github.com/apache/beam-site.git
+$ cd beam-site
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam-site.git
+$ git fetch --all
+$ git checkout -b <my-branch> origin/release-docs
+</code></pre>
+</div>
+
+<p>Further instructions on website development on <code class="highlighter-rouge">apache/beam</code> is
+<a href="https://github.com/apache/beam/blob/master/website">here</a>. Background
+information about how the website is updated can be found in <a href="https://s.apache.org/beam-site-automation">Beam-Site
+Automation Reliability</a>.</p>
<h4 id="register-to-pypi">Register to PyPI</h4>
@@ -932,20 +947,20 @@ When prompted for a description, enter “Apache Beam, version X, release candid
</li>
<li>Stage source release into dist.apache.org dev <a href="https://dist.apache.org/repos/dist/dev/beam/">repo</a>.</li>
<li>Stage,sign and hash python binaries into dist.apache.ord dev repo python dir</li>
- <li>Create a PR to update beam-site, changes includes:
+ <li>Create a PR to update beam and beam-site, changes includes:
<ul>
<li>Copy python doc into beam-site</li>
<li>Copy java doc into beam-site</li>
- <li>Update release version into <a href="https://github.com/apache/beam-site/blob/asf-site/_config.yml">_config.yml</a>.</li>
+ <li>Update release version into <a href="https://github.com/apache/beam/blob/master/website/_config.yml">_config.yml</a>.</li>
</ul>
</li>
</ol>
</li>
<li>Tasks you need to do manually
<ol>
- <li>Add new release into src/get-started/downloads.md</li>
- <li>Update last release download links in src/get-started/downloads.md</li>
- <li>Update the Pydoc link on this page to point to the new version (in src/documentation/sdks/pydoc/current.md.</li>
+ <li>Add new release into <code class="highlighter-rouge">website/src/get-started/downloads.md</code>.</li>
+ <li>Update last release download links in <code class="highlighter-rouge">website/src/get-started/downloads.md</code>.</li>
+ <li>Update <code class="highlighter-rouge">website/src/.htaccess</code> to redirect to the new version.</li>
</ol>
</li>
</ul>
@@ -1068,7 +1083,6 @@ svn commit
<p>Make sure you have <code class="highlighter-rouge">tox</code> installed:</p>
<div class="highlighter-rouge"><pre class="highlight"><code>pip install tox
-
</code></pre>
</div>
<p>Create the Python SDK documentation using sphinx by running a helper script.</p>
@@ -1077,38 +1091,52 @@ svn commit
</div>
<p>By default the Pydoc is generated in <code class="highlighter-rouge">sdks/python/target/docs/_build</code>. Let <code class="highlighter-rouge">${PYDOC_ROOT}</code> be the absolute path to <code class="highlighter-rouge">_build</code>.</p>
-<h4 id="propose-a-pull-request-for-website-updates">Propose a pull request for website updates</h4>
-
-<p>The final step of building the candidate is to propose a website pull request.</p>
+<h4 id="propose-pull-requests-for-website-updates">Propose pull requests for website updates</h4>
-<p>Start by updating <code class="highlighter-rouge">release_latest</code> version flag in the top-level <code class="highlighter-rouge">_config.yml</code>, and list the new release in the <a href="/get-started/downloads/">Apache Beam Downloads</a>, linking to the source code download and the Release Notes in JIRA.</p>
+<p>Beam publishes API reference manuals for each release on the website. 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>Beam publishes API reference manual for each release on the website. For Java SDK, that’s Javadoc.</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.</p>
-<p>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.</p>
+<p><strong>PR 1: apache/beam-site</strong></p>
-<p>Add the new Javadoc to <a href="https://beam.apache.org/releases/javadoc/">SDK API Reference page</a> page, as follows:</p>
+<p>This pull request is against the <code class="highlighter-rouge">apache/beam-site</code> repo, on the <code class="highlighter-rouge">release-docs</code>
+branch.</p>
<ul>
- <li>Unpack the Maven artifact <code class="highlighter-rouge">org.apache.beam:beam-sdks-java-javadoc</code> into some temporary location. Call this <code class="highlighter-rouge">${JAVADOC_TMP}</code>.</li>
- <li>Copy the generated Javadoc into the website repository: <code class="highlighter-rouge">cp -r ${JAVADOC_TMP} src/documentation/sdks/javadoc/${RELEASE}</code>.</li>
- <li>Set up the necessary git commands to account for the new and deleted files from the javadoc.</li>
- <li>Update the Javadoc link on this page to point to the new version (in <code class="highlighter-rouge">src/documentation/sdks/javadoc/current.md</code>).</li>
+ <li>Add the new Javadoc to <a href="https://beam.apache.org/releases/javadoc/">SDK API Reference page</a> page, as follows:
+ <ul>
+ <li>Unpack the Maven artifact <code class="highlighter-rouge">org.apache.beam:beam-sdks-java-javadoc</code> into some temporary location. Call this <code class="highlighter-rouge">${JAVADOC_TMP}</code>.</li>
+ <li>Copy the generated Javadoc into the website repository: <code class="highlighter-rouge">cp -r ${JAVADOC_TMP} javadoc/${RELEASE}</code>.</li>
+ </ul>
+ </li>
+ <li>Add the new Pydoc to <a href="https://beam.apache.org/releases/pydoc/">SDK API Reference page</a> page, as follows:
+ <ul>
+ <li>Copy the generated Pydoc into the website repository: <code class="highlighter-rouge">cp -r ${PYDOC_ROOT} pydoc/${RELEASE}</code>.</li>
+ <li>Remove <code class="highlighter-rouge">.doctrees</code> directory.</li>
+ </ul>
+ </li>
+ <li>Stage files using: <code class="highlighter-rouge">git add --all javadoc/ pydoc/</code>.</li>
</ul>
-<h5 id="create-pydoc">Create Pydoc</h5>
-<p>Add the new Pydoc to <a href="https://beam.apache.org/releases/pydoc/">SDK API Reference page</a> page, as follows:</p>
+<p><strong>PR 2: apache/beam</strong></p>
+
+<p>This pull request is against the <code class="highlighter-rouge">apache/beam</code> repo, on the <code class="highlighter-rouge">master</code> branch.</p>
<ul>
- <li>Copy the generated Pydoc into the website repository: <code class="highlighter-rouge">cp -r ${PYDOC_ROOT} src/documentation/sdks/pydoc/${RELEASE}</code>.</li>
- <li>Remove <code class="highlighter-rouge">.doctrees</code> directory.</li>
- <li>Update the Pydoc link on this page to point to the new version (in <code class="highlighter-rouge">src/documentation/sdks/pydoc/current.md</code>).</li>
+ <li>Update the <code class="highlighter-rouge">release_latest</code> version flag in <code class="highlighter-rouge">/website/_config.yml</code>, and list
+the new release in <code class="highlighter-rouge">/website/src/get-started/downloads.md</code>, linking to the
+source code download and the Release Notes in JIRA.</li>
+ <li>Update the <code class="highlighter-rouge">RedirectMatch</code> rule in
+<a href="https://github.com/apache/beam/blob/master/website/src/.htaccess">/website/src/.htaccess</a>
+to point to the new release. See file history for examples.</li>
</ul>
-<p>Finally, propose a pull request with these changes. (Don’t merge before finalizing the release.)</p>
-
<h4 id="build-and-stage-python-wheels">Build and stage python wheels</h4>
<p>There is a wrapper repo <a href="https://github.com/apache/beam-wheels">beam-wheels</a> to help build python wheels.</p>
diff --git a/website/generated-content/contribute/website-contributions/index.html b/website/generated-content/contribute/website-contributions/index.html
deleted file mode 100644
index 6c1a0fa..0000000
--- a/website/generated-content/contribute/website-contributions/index.html
+++ /dev/null
@@ -1,369 +0,0 @@
-<!DOCTYPE html>
-<!--
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. See accompanying LICENSE file.
--->
-
-<html lang="en">
- <!--
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. See accompanying LICENSE file.
--->
-
-<head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <title>Beam Website Contributions</title>
- <meta name="description" content="Apache Beam is an open source, unified model and set of language-specific SDKs for defining and executing data processing workflows, and also data ingestion and integration flows, supporting Enterprise Integration Patterns (EIPs) and Domain Specific Languages (DSLs). Dataflow pipelines simplify the mechanics of large-scale batch and streaming data processing and can run on a number of runtimes like Apache Flink, Apache Spark, and Google Cloud Dataflow [...]
-">
- <link href="https://fonts.googleapis.com/css?family=Roboto:100,300,400" rel="stylesheet">
- <link rel="stylesheet" href="/css/site.css">
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.0/jquery.min.js"></script>
- <script src="/js/bootstrap.min.js"></script>
- <script src="/js/language-switch.js"></script>
- <script src="/js/fix-menu.js"></script>
- <script src="/js/section-nav.js"></script>
- <script src="/js/page-nav.js"></script>
- <link rel="canonical" href="https://beam.apache.org/contribute/website-contributions/" data-proofer-ignore>
- <link rel="shortcut icon" type="image/x-icon" href="/images/favicon.ico">
- <link rel="alternate" type="application/rss+xml" title="Apache Beam" href="https://beam.apache.org/feed.xml">
- <script>
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
- ga('create', 'UA-73650088-1', 'auto');
- ga('send', 'pageview');
- </script>
-</head>
-
- <body class="body" data-spy="scroll" data-target=".page-nav" data-offset="0">
- <!--
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. See accompanying LICENSE file.
--->
-
-<nav class="header navbar navbar-fixed-top">
- <div class="navbar-header">
- <button type="button" class="navbar-toggle" aria-expanded="false" aria-controls="navbar">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- <a href="/" class="navbar-brand" >
- <img alt="Brand" style="height: 25px" src="/images/beam_logo_navbar.png">
- </a>
- </div>
-
- <div class="navbar-mask closed"></div>
-
- <div id="navbar" class="navbar-container closed">
- <ul class="nav navbar-nav">
- <li>
- <a href="/get-started/beam-overview/">Get Started</a>
- </li>
- <li>
- <a href="/documentation/">Documentation</a>
- </li>
- <li>
- <a href="/documentation/sdks/java/">SDKS</a>
- </li>
- <li>
- <a href="/documentation/runners/capability-matrix/">RUNNERS</a>
- </li>
- <li>
- <a href="/contribute/">Contribute</a>
- </li>
- <li>
- <a href="/community/contact-us/">Community</a>
- </li>
- <li><a href="/blog">Blog</a></li>
- </ul>
- <ul class="nav navbar-nav navbar-right">
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"><img src="https://www.apache.org/foundation/press/kit/feather_small.png" alt="Apache Logo" style="height:20px;"><span class="caret"></span></a>
- <ul class="dropdown-menu dropdown-menu-right">
- <li><a href="http://www.apache.org/">ASF Homepage</a></li>
- <li><a href="http://www.apache.org/licenses/">License</a></li>
- <li><a href="http://www.apache.org/security/">Security</a></li>
- <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
- <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
- <li><a href="https://www.apache.org/foundation/policies/conduct">Code of Conduct</a></li>
- </ul>
- </li>
- </ul>
- </div>
-</nav>
-
- <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>
- <!--
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. See accompanying LICENSE file.
--->
-
-<li><span class="section-nav-list-main-title">Contribute</span></li>
-<li><a href="/contribute/">Get started contributing</a></li>
-<li>
- <span class="section-nav-list-title">IDE tips</span>
-
- <ul class="section-nav-list">
- <li><a href="https://cwiki.apache.org/confluence/display/BEAM/IntelliJ+Tips">IntelliJ Tips</a></li>
- <li><a href="https://cwiki.apache.org/confluence/display/BEAM/Eclipse+Tips">Eclipse Tips</a></li>
- </ul>
-</li>
-<li>
- <span class="section-nav-list-title">Technical Docs</span>
-
- <ul class="section-nav-list">
- <li><a href="/contribute/testing/">Testing guide</a></li>
- <ul>
- <li><a href="/contribute/precommit-triage-guide/">Pre-commit Slowness Triage Guide</a></li>
- </ul>
- <li><a href="/contribute/ptransform-style-guide/">PTransform style guide</a></li>
- <li><a href="/contribute/runner-guide/">Runner authoring guide</a></li>
- <li><a href="/contribute/portability/">Portability Framework</a></li>
- <li><a href="/contribute/docker-images/">Docker images</a></li>
- <li><a href="/contribute/design-documents/">Design documents</a></li>
- <li><a href="/contribute/dependencies/">Dependencies guide</a></li>
- </ul>
-</li>
-<li>
- <span class="section-nav-list-title">Policies</span>
- <ul class="section-nav-list">
- <li><a href="/contribute/precommit-policies/">Pre-commit test policies</a></li>
- <li><a href="/contribute/postcommits-policies/">Post-commit test policies</a></li>
- </ul>
-</li>
-<li>
- <span class="section-nav-list-title">Committers</span>
-
- <ul class="section-nav-list">
- <li><a href="/contribute/become-a-committer/">Become a committer</a></li>
- <li><a href="/contribute/committer-guide/">Committer guide</a></li>
- <li><a href="/contribute/release-guide/">Release guide</a></li>
- </ul>
-</li>
-
- </ul>
- </nav>
- </div>
-
- <nav class="page-nav clearfix" data-offset-top="90" data-offset-bottom="500">
- <!--
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. See accompanying LICENSE file.
--->
-
-
-
-<ul class="nav">
- <li><a href="#one-time-setup">One-time Setup</a></li>
- <li><a href="#working-on-your-change">Working on your change</a></li>
- <li><a href="#committing-website-changes-committers-only">Committing website changes (committers only)</a></li>
-</ul>
-
-
- </nav>
-
- <div class="body__contained body__section-nav">
- <!--
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
--->
-
-<h1 id="website-contributions">Website Contributions</h1>
-
-<p>Contributions to the website require the same steps as contributions to the
-main repository, so start with the instructions for <a href="/contribute/contribution-guide">Contributing
-Code</a>.</p>
-
-<p>The Beam website is in the <a href="https://github.com/apache/beam-site">Beam Site GitHub
-mirror</a> repository in the <code class="highlighter-rouge">asf-site</code>
-branch (<em>not</em> <code class="highlighter-rouge">master</code>).</p>
-
-<p>Issues are tracked in the
-<a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20BEAM%20AND%20component%20%3D%20website">website</a>
-component in JIRA.</p>
-
-<h2 id="one-time-setup">One-time Setup</h2>
-
-<p>The <a href="https://github.com/apache/beam-site/blob/asf-site/README.md">README file</a>
-in the website repository has more information on how to set up the required
-dependencies for your development environment.</p>
-
-<p>The general guidelines for cloning a repository can be adjusted to use the
-<code class="highlighter-rouge">asf-site</code> branch of <code class="highlighter-rouge">beam-site</code>:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>$ git clone -b asf-site https://github.com/apache/beam-site.git
-$ cd beam-site
-$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam-site.git
-$ git fetch --all
-$ git checkout -b <my-branch> origin/asf-site
-</code></pre>
-</div>
-
-<h2 id="working-on-your-change">Working on your change</h2>
-
-<p>While you are working on your pull request, you can test and develop live by
-running the following command in the root folder of the website:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>$ bundle exec jekyll serve --incremental
-</code></pre>
-</div>
-
-<p>Jekyll will start a webserver on port 4000. As you make changes to the content,
-Jekyll will rebuild it automatically.</p>
-
-<p>In addition, you can run the tests to valid your links using:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>$ bundle exec rake test
-</code></pre>
-</div>
-
-<p>Both of these commands will cause the <code class="highlighter-rouge">content/</code> directory to be generated.
-Merging autogenerated content can get tricky, so please leave this directory
-out of your commits and pull request by doing:</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>$ git checkout -- content
-</code></pre>
-</div>
-
-<p>When you are ready, submit a pull request using the <a href="https://github.com/apache/beam-site">Beam Site GitHub
-mirror</a>, including the JIRA issue as
-usual.</p>
-
-<p>During review, committers will patch in your PR, generate the static
-<code class="highlighter-rouge">content/</code>, and review the changes.</p>
-
-<h2 id="committing-website-changes-committers-only">Committing website changes (committers only)</h2>
-
-<p>We have a bot that runs tests and merges changes to the website.
-When the pull request is fully ready to be merged, a committer
-can comment</p>
-
-<div class="highlighter-rouge"><pre class="highlight"><code>@asfgit merge
-</code></pre>
-</div>
-
-
- </div>
- </div>
- <!--
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. See accompanying LICENSE file.
--->
-
-<footer class="footer">
- <div class="footer__contained">
- <div class="footer__cols">
- <div class="footer__cols__col">
- <div class="footer__cols__col__logo">
- <img src="/images/beam_logo_circle.svg" class="footer__logo" alt="Beam logo">
- </div>
- <div class="footer__cols__col__logo">
- <img src="/images/apache_logo_circle.svg" class="footer__logo" alt="Apache logo">
- </div>
- </div>
- <div class="footer__cols__col footer__cols__col--md">
- <div class="footer__cols__col__title">Start</div>
- <div class="footer__cols__col__link"><a href="/get-started/beam-overview/">Overview</a></div>
- <div class="footer__cols__col__link"><a href="/get-started/quickstart-java/">Quickstart (Java)</a></div>
- <div class="footer__cols__col__link"><a href="/get-started/quickstart-py/">Quickstart (Python)</a></div>
- <div class="footer__cols__col__link"><a href="/get-started/quickstart-go/">Quickstart (Go)</a></div>
- <div class="footer__cols__col__link"><a href="/get-started/downloads/">Downloads</a></div>
- </div>
- <div class="footer__cols__col footer__cols__col--md">
- <div class="footer__cols__col__title">Docs</div>
- <div class="footer__cols__col__link"><a href="/documentation/programming-guide/">Concepts</a></div>
- <div class="footer__cols__col__link"><a href="/documentation/pipelines/design-your-pipeline/">Pipelines</a></div>
- <div class="footer__cols__col__link"><a href="/documentation/runners/capability-matrix/">Runners</a></div>
- </div>
- <div class="footer__cols__col footer__cols__col--md">
- <div class="footer__cols__col__title">Community</div>
- <div class="footer__cols__col__link"><a href="/contribute/">Contribute</a></div>
- <div class="footer__cols__col__link"><a href="https://projects.apache.org/committee.html?beam" target="_blank">Team<img src="/images/external-link-icon.png"
- width="14" height="14"
- alt="External link."></a></div>
- <div class="footer__cols__col__link"><a href="/contribute/presentation-materials/">Media</a></div>
- </div>
- <div class="footer__cols__col footer__cols__col--md">
- <div class="footer__cols__col__title">Resources</div>
- <div class="footer__cols__col__link"><a href="/blog/">Blog</a></div>
- <div class="footer__cols__col__link"><a href="/get-started/support/">Support</a></div>
- <div class="footer__cols__col__link"><a href="https://github.com/apache/beam">GitHub</a></div>
- </div>
- </div>
- </div>
- <div class="footer__bottom">
- ©
- <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>
-</footer>
-
- </body>
-</html>