beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From git-site-r...@apache.org
Subject [beam] branch asf-site updated: Publishing website 2021/06/02 00:03:27 at commit 5a029fd
Date Wed, 02 Jun 2021 00:04:16 GMT
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 ce9e4eb  Publishing website 2021/06/02 00:03:27 at commit 5a029fd
ce9e4eb is described below

commit ce9e4eb400ef43283cfb82d9d78190fe552b2196
Author: jenkins <builds@apache.org>
AuthorDate: Wed Jun 2 00:03:27 2021 +0000

    Publishing website 2021/06/02 00:03:27 at commit 5a029fd
---
 website/generated-content/contribute/index.html | 46 ++++++++++++++++++-------
 website/generated-content/sitemap.xml           |  2 +-
 2 files changed, 35 insertions(+), 13 deletions(-)

diff --git a/website/generated-content/contribute/index.html b/website/generated-content/contribute/index.html
index c7f8696..eddac8a 100644
--- a/website/generated-content/contribute/index.html
+++ b/website/generated-content/contribute/index.html
@@ -18,26 +18,27 @@
 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 href=https://stackoverflow.com/questions/tagged/apache-beam>stackoverflow</a></li><li>review
proposed design ideas on <a href=/community/contact-us/>dev@beam.apache.org</a></li><li>improve
the documentation</li><li>file <a href=https://issues.apache.org/jira/projects/BEAM/issues>bug
reports</a></li><li>test releases</li><li>review <a href=https://github.com/apache/beam/pulls>changes</a></li><li>write
new examples</li><li>improve your favorite language SDK (Java, Python, Go, etc)</li><
[...]
 Cloud Dataflow, etc)</li><li>improve or add IO connectors</li><li>add
new transform libraries (statistics, ML, image processing, etc)</li><li>work on
the core programming model (what is a Beam pipeline and how does it
 run?)</li><li>improve the developer experience (for example, Windows guides)</li><li>add
answers to the <a href=https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ>contribution
FAQ</a></li><li>organize local meetups of users or contributors to Apache
Beam</li></ul></div><a class=arrow-list-header data-toggle=collapse href=#collapseContributing
role=button aria-expanded=false aria-controls=collapseContributing><figure><img
src=/images/arrow-icon_list.svg></figure><h2 id=contr [...]
-detail.</p><h3 id=prerequisites>Prerequisites</h3><ul><li>a
GitHub account</li><li>a Linux, macOS, or Microsoft Windows development environment
with Java JDK 8 installed</li><li><a href=https://www.docker.com/>Docker</a>
installed for some tasks including building worker containers and testing this website
-changes locally</li><li><a href=https://golang.org>Go</a> 1.12 or
later installed for Go SDK development</li><li>Python 3.6, 3.7, and 3.8. Yes,
you need all three versions installed.<ul><li>pip, setuptools, virtualenv, and
tox installed for Python development</li></ul></li><li>for large contributions,
a signed <a href=https://www.apache.org/licenses/icla.pdf>Individual Contributor License
+detail.</p><h3 id=prerequisites>Prerequisites</h3><ul><li>A
GitHub account.</li><li>A Linux, macOS, or Microsoft Windows development environment</li><li>Java
JDK 8 installed</li><li><a href=https://www.docker.com/>Docker</a>
installed for some tasks including building worker containers and testing this website
+changes locally.</li><li>For SDK Development:<ul><li><a href=https://golang.org>Go</a>
1.12 or later installed for Go SDK development</li></ul></li><li>Python
3.6, 3.7, and 3.8. Yes, you need all three versions installed.<ul><li>pip, setuptools,
virtualenv, and tox installed for Python development</li></ul></li><li>For
large contributions, a signed <a href=https://www.apache.org/licenses/icla.pdf>Individual
Contributor License
 Agreement</a> (ICLA) to the Apache
-Software Foundation (ASF).</li></ul><p>To install these in a Debian-based
distribution:</p><pre><code>sudo apt-get install \
+Software Foundation (ASF).</li></ul><h3 id=configuration-options>Configuration
options</h3><p>You have two options for configuring your development environment:</p><ul><li>Local:<ul><li>Manually
installing the prerequisites listed above.</li><li>Using the automated script
for Linux and macOS.</li></ul></li><li>Container: using a Docker image.</li></ul><h4
id=local-debian-based-distribution>Local: Debian-based Distribution</h4><h5 id=manual-steps>Manual
steps</h5><p>To install these in a  [...]
    openjdk-8-jdk \
    python-setuptools \
    python-pip \
    virtualenv \
    tox \
    docker-ce
-</code></pre><p>On some systems (like Ubuntu 20.04) these need to be installed
also</p><pre><code>pip3 install grpcio-tools mypy-protobuf
-</code></pre><p>You also need to <a href=https://golang.org/doc/install>install
Go</a>.</p><p>Once Go is installed, install goavro:</p><pre><code>$
export GOPATH=`pwd`/sdks/go/examples/.gogradle/project_gopath
+</code></pre><ol start=2><li>On some systems, like Ubuntu 20.04,
install these:</li></ol><pre><code>pip3 install grpcio-tools mypy-protobuf
+</code></pre><ol start=3><li>If you you develop in GO:<ol><li>Install
<a href=https://golang.org/doc/install>Go</a>.</li><li>Check BEAM
repo is in: <code>$GOPATH/src/github.com/apache/</code></li><li>At
the end, it should look like this: <code>$GOPATH/src/github.com/apache/beam</code></li></ol></li><li>Once
Go is installed, install goavro:</li></ol><pre><code>$ export GOPATH=`pwd`/sdks/go/examples/.gogradle/project_gopath
 $ go get github.com/linkedin/goavro
-</code></pre><p>gLinux users should configure their machines for sudoless
Docker.</p><p>Alternatively, you can use the Docker based local development environment
to wrap your clone of the Beam repo
+</code></pre><p><strong>Important</strong>: gLinux users should
configure their machines for sudoless Docker.</p><h5 id=automated-script-for-linux-and-macos>Automated
script for Linux and macOS</h5><p>You can install these in a Debian-based distribution
for Linux or macOs using the <a href=https://github.com/apache/beam/blob/master/local-env-setup.sh>local-env-setup.sh</a>
script, which is part of the Beam repo. It contains:</p><ul><li>pip3 packages</li><li>go
packages</li><li>goavro</li [...]
+</code></pre><h4 id=container-docker-based>Container: Docker-based</h4><p>Alternatively,
you can use the Docker based local development environment to wrap your clone of the Beam
repo
 into a container meeting the requirements above.</p><p>You can start this container
using the <a href=https://github.com/apache/beam/blob/master/start-build-env.sh>start-build-env.sh</a>
-script which is part of the Beam repo:</p><pre><code>./start-build-env.sh
+script which is part of the Beam repo:</p><ol><li>Execute:</li></ol><pre><code>./start-build-env.sh
 </code></pre><h3 id=connect-with-the-beam-community>Connect With the Beam
community</h3><ol><li>Consider subscribing to the <a href=/community/contact-us/>dev@
mailing list</a>, especially
 if you plan to make more than one change or the change will be large. All decisions happen
on the
 public dev list.</li><li>(Optionally) Join the <a href=/community/contact-us/>#beam
channel of the ASF slack</a>.</li><li>Create an account on <a href=https://issues.apache.org/jira/projects/BEAM/issues>Beam
issue tracker (JIRA)</a>
@@ -50,12 +51,33 @@ to introduce yourself and to be added as a contributor in the Beam issue
tracker
 ASF Jira Username. For example <a href=https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E>this
welcome email</a>.</li><li>If your change is large or it is your first change,
it is a good idea to
 <a href=/community/contact-us/>discuss it on the dev@ mailing list</a>.</li><li>For
large changes create a design doc
 (<a href=https://s.apache.org/beam-design-doc-template>template</a>,
-<a href=https://s.apache.org/beam-design-docs>examples</a>) and email it to the
<a href=/community/contact-us>dev@ mailing list</a>.</li></ol><h3
id=development-setup>Development Setup</h3><ol><li><p>If you need
help with git forking, cloning, branching, committing, pull requests, and squashing commits,
see
-<a href=https://cwiki.apache.org/confluence/display/BEAM/Git+Tips>Git workflow tips</a></p></li><li><p>Clone
the git repository. You can download it anywhere you like, however for Go development we recommend
putting it in your <a href=https://golang.org/doc/gopath_code#GOPATH><code>$GOPATH</code></a>
(<code>$HOME/go</code> by default on Unix systems).</p><pre><code>$
mkdir -p ~/go/src/github.com/apache
+<a href=https://s.apache.org/beam-design-docs>examples</a>) and email it to the
<a href=/community/contact-us>dev@ mailing list</a>.</li></ol><h3
id=development-setup>Development Setup</h3><ol><li><p>Check <a
href=https://cwiki.apache.org/confluence/display/BEAM/Git+Tips>Git workflow tips</a>
if you need help with git forking, cloning, branching, committing, pull requests, and squashing
commits.</p></li><li><p>Clone the git repository. You can download
it anywhere you like.</p><pre><code [...]
 $ cd ~/go/src/github.com/apache
 $ git clone https://github.com/apache/beam
 $ cd beam
-</code></pre></li><li><p>Familiarize yourself with gradle and
the project structure. At the root of the git repository, run:</p><pre><code>$
./gradlew projects
+
+- For Go development:
+We recommend putting it in your [`$GOPATH`](https://golang.org/doc/gopath_code#GOPATH) (`$HOME/go`
by default on Unix systems).
+   1. Clone the repo, and update your branch as normal
+           $ git clone https://github.com/apache/beam.git
+           $ cd beam
+           $ git remote add &lt;GitHub_user&gt; git@github.com:&lt;GitHub_user&gt;/beam.git
+           $ git fetch --all
+   1. Get or Update all the Go SDK dependencies
+           $ go get -u ./...
+</code></pre></li><li><p>Check the environment was set up correctly.</p><ul><li><p><strong>Option
1</strong>: validate the Go, Java, and Python environments:</p><p><strong>Important</strong>:
Make sure you have activated Python development.</p></li></ul></li></ol><pre><code>./gradlew
:checkSetup
+</code></pre><pre><code>- **Option 2**: Run independent checks:
+    - For **Go development**:
+      1. Execute:
+</code></pre><pre><code>export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore
+./gradlew :sdks:go:examples:wordCount
+</code></pre><pre><code>     - For **Python development**:
+      1. Execute:
+</code></pre><pre><code>./gradlew :sdks:python:wordCount
+</code></pre><pre><code>    - For **Java development**:
+      1. Execute:
+</code></pre><pre><code>./gradlew :examples:java:wordCount
+</code></pre><ol><li><p>Familiarize yourself with gradle and
the project structure. At the root of the git repository, run:</p><pre><code>$
./gradlew projects
 </code></pre><p>Examine the available tasks in a project. For the default
set of tasks, use:</p><pre><code>$ ./gradlew tasks
 </code></pre><p>For a given module, use:</p><pre><code>$
./gradlew -p sdks/java/io/cassandra tasks
 </code></pre><p>For an exhaustive list of tasks, use:</p><pre><code>$
./gradlew tasks --all
@@ -102,7 +124,7 @@ Anyone has read access. If you wish to contribute changes, please create
an acco
 <a href=/contribute/ptransform-style-guide>PTransform Style Guide</a>.</p><p>If
you are contributing a Runner to Beam, refer to the
 <a href=/contribute/runner-guide/>Runner authoring guide</a></p><p>Review
<a href=https://s.apache.org/beam-design-docs>design documents</a>.</p><p>A
great way to contribute is to join an existing effort. For the most
 intensive efforts, check out the <a href=/roadmap/>roadmap</a>.</p><p>You
can also find a more exhaustive list on the <a href=https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam>Beam
developers&rsquo; wiki</a></p><h2 id=troubleshooting>Troubleshooting</h2><p>If
you run into any issues, check out the <a href=https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ>contribution
FAQ</a> or ask on the <a href=/community/contact-us/>dev@ mailing list</a>
or <a href=/community [...]
-<a href=/community/contact-us>reach out to the Beam community</a>.</p><div
class=feedback><p class=update>Last updated on 2021/03/12</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__containe [...]
+<a href=/community/contact-us>reach out to the Beam community</a>.</p><div
class=feedback><p class=update>Last updated on 2021/06/01</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__containe [...]
 <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 9244361..8e6b55f 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.29.0/</loc><lastmod>2021-04-15T20:51:50-07:00</lastmod></url><url><loc>/categories/blog/</loc><lastmod>2021-04-15T20:51:50-07:00</lastmod></url><url><loc>/blog/</loc><lastmod>2021-04-15T20:51:50-07:00</lastmod></url><url><loc>/categories/</loc><lastmod>2021-05-25T17:22:37-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.29.0/</loc><lastmod>2021-04-15T20:51:50-07:00</lastmod></url><url><loc>/categories/blog/</loc><lastmod>2021-04-15T20:51:50-07:00</lastmod></url><url><loc>/blog/</loc><lastmod>2021-04-15T20:51:50-07:00</lastmod></url><url><loc>/categories/</loc><lastmod>2021-05-25T17:22:37-07:00</lastmod></url><url><loc>/blog/b
[...]
\ No newline at end of file

Mime
View raw message