TheNeuralBit commented on a change in pull request #13565:
URL: https://github.com/apache/beam/pull/13565#discussion_r570314467
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
+
+## Overview
+
+</a>
+
+<div class="collapse dont-collapse-sm" id="collapseOverview">
-The Apache Beam community welcomes contributions from anyone!
+There are lots of opportunities to contribute. You can for example:
-If you have questions, please [reach out to the Beam
community](/contribute/get-help).
+* ask or answer questions on [[email protected]](/community/contact-us/) or
+ [stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
+* review proposed design ideas on
[[email protected]](/community/contact-us/)
+* file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
+* review [changes](https://github.com/apache/beam/pulls)
+* work on the core programming model (what is a Beam pipeline and how does it
+ run?)
+* improve the developer experience (for example, Windows guides)
+* organize local meetups of users or contributors to Apache Beam
-There are lots of opportunities to contribute:
+...and many more. Most importantly, if you have an idea of how to contribute,
then do it!
Review comment:
This `...` doesn't render correctly:
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
+
+## Overview
+
+</a>
+
+<div class="collapse dont-collapse-sm" id="collapseOverview">
-The Apache Beam community welcomes contributions from anyone!
+There are lots of opportunities to contribute. You can for example:
-If you have questions, please [reach out to the Beam
community](/contribute/get-help).
+* ask or answer questions on [[email protected]](/community/contact-us/) or
+ [stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
+* review proposed design ideas on
[[email protected]](/community/contact-us/)
+* file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
+* review [changes](https://github.com/apache/beam/pulls)
+* work on the core programming model (what is a Beam pipeline and how does it
+ run?)
+* improve the developer experience (for example, Windows guides)
+* organize local meetups of users or contributors to Apache Beam
-There are lots of opportunities to contribute:
+...and many more. Most importantly, if you have an idea of how to contribute,
then do it!
- - ask or answer questions on [[email protected]](/community/contact-us/) or
-[stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
- - review proposed design ideas on
[[email protected]](/community/contact-us/)
- - improve the documentation
- - file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
- - test releases
- - review [changes](https://github.com/apache/beam/pulls)
- - write new examples
- - improve your favorite language SDK (Java, Python, Go, etc)
- - improve specific runners (Apache Flink, Apache Spark, Google
- Cloud Dataflow, etc)
- - improve or add IO connectors
- - add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
- - improve the developer experience (for example, Windows guides)
- - add answers to the [contribution FAQ](
- https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ)
- - organize local meetups of users or contributors to Apache Beam
+</div>
-Most importantly, if you have an idea of how to contribute, then do it!
+<a class="arrow-list-header" data-toggle="collapse"
href="#collapseContributing" role="button" aria-expanded="false"
aria-controls="collapseContributing">
+ {{< figure src="/images/arrow-icon_list.svg">}}
## Contributing code
+ </a>
+
+<div class="collapse dont-collapse-sm" id="collapseContributing">
+
Below is a tutorial for contributing code to Beam, covering our tools and
typical process in
detail.
### Prerequisites
-To contribute code, you need
+* a GitHub account
+* a Linux, macOS, or Microsoft Windows development environment with Java JDK 8
installed
+* [Docker](https://www.docker.com/) installed for some tasks including
building worker containers and testing this website
+ changes locally
+* [Go](https://golang.org) 1.12 or later installed for Go SDK development
+* Python 3.6, 3.7, and 3.8. Yes, you need all four versions installed.
+
+ pip, setuptools, virtualenv, and tox installed for Python development
+
+* for large contributions, a signed [Individual Contributor License
+ Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
+ Software Foundation (ASF).
- - a GitHub account
- - a Linux, macOS, or Microsoft Windows development environment with Java JDK
8 installed
- - [Docker](https://www.docker.com/) installed for some tasks including
building worker containers and testing this website
- changes locally
- - [Go](https://golang.org) 1.12 or later installed for Go SDK development
- - Python 3.6, 3.7, and 3.8. Yes, you need all three versions installed.
- - pip, setuptools, virtualenv, and tox installed for Python development
- - for large contributions, a signed [Individual Contributor License
- Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
- Software Foundation (ASF).
Review comment:
Can we just keep this section the same as it was before? The change
doesn't seem to be substantive, just changing bullet points.
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -97,16 +107,7 @@ $ export
GOPATH=`pwd`/sdks/go/examples/.gogradle/project_gopath
$ go get github.com/linkedin/goavro
```
-gLinux users should configure their machines for sudoless Docker.
-
-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.
-
-You can start this container using the
[start-build-env.sh](https://github.com/apache/beam/blob/master/start-build-env.sh)
-script which is part of the Beam repo:
-```
-./start-build-env.sh
-```
Review comment:
This section is missing in the new version.
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
Can you confirm that these expand buttons are working as intended? The
behavior seems odd to me.
On desktop:
- Content is always expanded, no arrow shows up. This could be intentional,
but also ...
- The headings look like links, and when I hover the underline goes away,
but its not actually clickable.
On mobile:
- The contributing code section only collapses to down to "To install these
in a debian-based distribution"
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -127,173 +128,9 @@ script which is part of the Beam repo:
1. Assign the issue to yourself. To get the permission to do so, email
the [dev@ mailing list](/community/contact-us)
to introduce yourself and to be added as a contributor in the Beam issue
tracker including your
- ASF Jira Username. For example [this welcome email](
-
https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E).
+ ASF Jira Username. For example [this welcome
email](https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E).
1. If your change is large or it is your first change, it is a good idea to
[discuss it on the dev@ mailing list](/community/contact-us/).
1. For large changes create a design doc
([template](https://s.apache.org/beam-design-doc-template),
[examples](https://s.apache.org/beam-design-docs)) and email it to the
[dev@ mailing list](/community/contact-us).
-
-### Development Setup {#development-setup}
-
-1. If you need help with git forking, cloning, branching, committing, pull
requests, and squashing commits, see
- [Git workflow
tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips)
-1. Familiarize yourself with gradle and the project structure. At the root of
the git repository, run:
Review comment:
I don't think that's a good idea. Before we remove a completele remove a
section there should be a discussion on the mailing list to make sure the
community agrees this section isn't valuable.
Could you leave it in for now? We can file a follow-up jira to consider
removing it.
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
+
+## Overview
+
+</a>
+
+<div class="collapse dont-collapse-sm" id="collapseOverview">
-The Apache Beam community welcomes contributions from anyone!
+There are lots of opportunities to contribute. You can for example:
-If you have questions, please [reach out to the Beam
community](/contribute/get-help).
+* ask or answer questions on [[email protected]](/community/contact-us/) or
+ [stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
+* review proposed design ideas on
[[email protected]](/community/contact-us/)
+* file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
+* review [changes](https://github.com/apache/beam/pulls)
+* work on the core programming model (what is a Beam pipeline and how does it
+ run?)
+* improve the developer experience (for example, Windows guides)
+* organize local meetups of users or contributors to Apache Beam
-There are lots of opportunities to contribute:
+...and many more. Most importantly, if you have an idea of how to contribute,
then do it!
Review comment:
It still looks the same to me
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
Can you confirm that these expand buttons are working as intended? The
behavior seems odd to me.
On desktop:
- [ ] Content is always expanded, no arrow shows up. This could be
intentional, but also ...
- [ ] The headings look like links, and when I hover the underline goes
away, but its not actually clickable.
On mobile:
- [ ] The contributing code section only collapses to down to "To install
these in a debian-based distribution"
- [ ] Clicking the arrows to expand has no effect
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
+
+## Overview
+
+</a>
+
+<div class="collapse dont-collapse-sm" id="collapseOverview">
-The Apache Beam community welcomes contributions from anyone!
+There are lots of opportunities to contribute. You can for example:
-If you have questions, please [reach out to the Beam
community](/contribute/get-help).
+* ask or answer questions on [[email protected]](/community/contact-us/) or
+ [stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
+* review proposed design ideas on
[[email protected]](/community/contact-us/)
+* file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
+* review [changes](https://github.com/apache/beam/pulls)
+* work on the core programming model (what is a Beam pipeline and how does it
+ run?)
+* improve the developer experience (for example, Windows guides)
+* organize local meetups of users or contributors to Apache Beam
-There are lots of opportunities to contribute:
+...and many more. Most importantly, if you have an idea of how to contribute,
then do it!
- - ask or answer questions on [[email protected]](/community/contact-us/) or
-[stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
- - review proposed design ideas on
[[email protected]](/community/contact-us/)
- - improve the documentation
- - file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
- - test releases
- - review [changes](https://github.com/apache/beam/pulls)
- - write new examples
- - improve your favorite language SDK (Java, Python, Go, etc)
- - improve specific runners (Apache Flink, Apache Spark, Google
- Cloud Dataflow, etc)
- - improve or add IO connectors
- - add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
- - improve the developer experience (for example, Windows guides)
- - add answers to the [contribution FAQ](
- https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ)
- - organize local meetups of users or contributors to Apache Beam
+</div>
-Most importantly, if you have an idea of how to contribute, then do it!
+<a class="arrow-list-header" data-toggle="collapse"
href="#collapseContributing" role="button" aria-expanded="false"
aria-controls="collapseContributing">
+ {{< figure src="/images/arrow-icon_list.svg">}}
## Contributing code
+ </a>
+
+<div class="collapse dont-collapse-sm" id="collapseContributing">
+
Below is a tutorial for contributing code to Beam, covering our tools and
typical process in
detail.
### Prerequisites
-To contribute code, you need
+* a GitHub account
+* a Linux, macOS, or Microsoft Windows development environment with Java JDK 8
installed
+* [Docker](https://www.docker.com/) installed for some tasks including
building worker containers and testing this website
+ changes locally
+* [Go](https://golang.org) 1.12 or later installed for Go SDK development
+* Python 3.6, 3.7, and 3.8. Yes, you need all four versions installed.
+
+ pip, setuptools, virtualenv, and tox installed for Python development
+
+* for large contributions, a signed [Individual Contributor License
+ Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
+ Software Foundation (ASF).
- - a GitHub account
- - a Linux, macOS, or Microsoft Windows development environment with Java JDK
8 installed
- - [Docker](https://www.docker.com/) installed for some tasks including
building worker containers and testing this website
- changes locally
- - [Go](https://golang.org) 1.12 or later installed for Go SDK development
- - Python 3.6, 3.7, and 3.8. Yes, you need all three versions installed.
- - pip, setuptools, virtualenv, and tox installed for Python development
- - for large contributions, a signed [Individual Contributor License
- Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
- Software Foundation (ASF).
Review comment:
Thank you
##########
File path: website/www/site/content/en/blog/beam-2.22.0.md
##########
@@ -18,7 +18,7 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
We are happy to present the new 2.22.0 release of Beam. This release includes
both improvements and new functionality.
-See the [download page](/get-started/downloads/#2220-2020-06-08) for this
release.<!--more-->
+See the [download page](/get-started/downloads/#2220-2020-06-08) for this
release.
Review comment:
It looks like you have restored all the blog posts (except for a weird
whitespace change in the 2.13.0 post). But there's still a lot of other files
that have recent changes backed out. See contribute/release-guide.md,
dsls/sql/overview.md, documentation/io/built-in/google-bigquery.md,
documentation/io/built-in/snowflake.md, documentation/programming-guide.md,
get-started/downloads.md, get-started/quickstart-java.md
##########
File path: website/www/site/content/en/blog/beam-2.22.0.md
##########
@@ -18,7 +18,7 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
We are happy to present the new 2.22.0 release of Beam. This release includes
both improvements and new functionality.
-See the [download page](/get-started/downloads/#2220-2020-06-08) for this
release.<!--more-->
+See the [download page](/get-started/downloads/#2220-2020-06-08) for this
release.
Review comment:
It looks like you have restored all the blog posts (except for a weird
whitespace change in the 2.13.0 post). But there's still a lot of other files
that have recent changes backed out. See contribute/release-guide.md,
dsls/sql/overview.md, documentation/io/built-in/google-bigquery.md,
documentation/io/built-in/snowflake.md, documentation/programming-guide.md,
get-started/downloads.md, get-started/quickstart-java.md, and others (this list
isn't exhaustive)
##########
File path: website/www/site/layouts/shortcodes/highlight.html
##########
@@ -12,20 +12,36 @@
{{ $content := (trim .Inner "\n\r") | htmlUnescape | safeHTML }}
{{ $ctx := . }}
-{{ with (.Get "class") }}
- <div class={{ . }}>
- {{ with ($ctx.Get "lang") }}
+{{ $py := .Get "py" }}
+{{ with (.Get "language") }}
+ <div class='{{ printf "language-%s" . }} snippet'>
+ <div class="notebook-skip code-snippet">
+ {{ with $py }}
+ <a target="_blank" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="Run code"
href="https://colab.research.google.com/github/{{ $ctx.Site.Params.branch_repo
}}/{{ $ctx.Get `notebook` }}-py.ipynb">
+ <img src="/images/run-icon.svg"/>
+ </a>
+ <a target="_blank" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="View source code" href="https://github.com/{{
$ctx.Site.Params.branch_repo }}/{{ $ctx.Get `py` }}">
+ <img src="/images/code-icon.svg"/>
+ </a>
+ <a class="copy" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="Copy to clipboard">
+ <img src="/images/copy-icon.svg"/>
+ </a>
+ {{ else }}
+ <a class="copy" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="Copy to clipboard">
+ <img src="/images/copy-icon.svg"/>
+ </a>
+ {{ end }}
{{ highlight $content . "" }}
- {{ else }}
- {{ highlight $content "" "" }}
- {{ end }}
+ </div>
</div>
{{ else }}
- {{ with (.Get 0) }}
- <div class={{ printf "language-%s" . }}>
- {{ highlight $content . "" }}
+ <div class="snippet">
+ <div class="notebook-skip code-snippet without_switcher">
+ <a class="copy" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="Copy to clipboard">
+ <img src="/images/copy-icon.svg"/>
+ </a>
+ {{ highlight $content "" "" }}
</div>
- {{ else }}
- {{ highlight $content "" "" }}
- {{ end }}
+ </div>
Review comment:
This looks great, thank you!
##########
File path: website/www/site/layouts/shortcodes/highlight.html
##########
@@ -12,20 +12,36 @@
{{ $content := (trim .Inner "\n\r") | htmlUnescape | safeHTML }}
{{ $ctx := . }}
-{{ with (.Get "class") }}
- <div class={{ . }}>
- {{ with ($ctx.Get "lang") }}
+{{ $py := .Get "py" }}
+{{ with (.Get "language") }}
+ <div class='{{ printf "language-%s" . }} snippet'>
+ <div class="notebook-skip code-snippet">
+ {{ with $py }}
+ <a target="_blank" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="Run code"
href="https://colab.research.google.com/github/{{ $ctx.Site.Params.branch_repo
}}/{{ $ctx.Get `notebook` }}-py.ipynb">
+ <img src="/images/run-icon.svg"/>
+ </a>
+ <a target="_blank" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="View source code" href="https://github.com/{{
$ctx.Site.Params.branch_repo }}/{{ $ctx.Get `py` }}">
+ <img src="/images/code-icon.svg"/>
+ </a>
+ <a class="copy" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="Copy to clipboard">
+ <img src="/images/copy-icon.svg"/>
+ </a>
+ {{ else }}
+ <a class="copy" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="Copy to clipboard">
+ <img src="/images/copy-icon.svg"/>
+ </a>
+ {{ end }}
{{ highlight $content . "" }}
- {{ else }}
- {{ highlight $content "" "" }}
- {{ end }}
+ </div>
</div>
{{ else }}
- {{ with (.Get 0) }}
- <div class={{ printf "language-%s" . }}>
- {{ highlight $content . "" }}
+ <div class="snippet">
+ <div class="notebook-skip code-snippet without_switcher">
+ <a class="copy" type="button" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="Copy to clipboard">
+ <img src="/images/copy-icon.svg"/>
+ </a>
+ {{ highlight $content "" "" }}
</div>
- {{ else }}
- {{ highlight $content "" "" }}
- {{ end }}
+ </div>
Review comment:
The last issue is resolved now, thanks
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -127,173 +128,9 @@ script which is part of the Beam repo:
1. Assign the issue to yourself. To get the permission to do so, email
the [dev@ mailing list](/community/contact-us)
to introduce yourself and to be added as a contributor in the Beam issue
tracker including your
- ASF Jira Username. For example [this welcome email](
-
https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E).
+ ASF Jira Username. For example [this welcome
email](https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E).
1. If your change is large or it is your first change, it is a good idea to
[discuss it on the dev@ mailing list](/community/contact-us/).
1. For large changes create a design doc
([template](https://s.apache.org/beam-design-doc-template),
[examples](https://s.apache.org/beam-design-docs)) and email it to the
[dev@ mailing list](/community/contact-us).
-
-### Development Setup {#development-setup}
-
-1. If you need help with git forking, cloning, branching, committing, pull
requests, and squashing commits, see
- [Git workflow
tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips)
-1. Familiarize yourself with gradle and the project structure. At the root of
the git repository, run:
Review comment:
Filed BEAM-11751 to maybe remove it in the future
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
Can you confirm that these expand buttons are working as intended? The
behavior seems odd to me.
On desktop:
- [ ] Content is always expanded, no arrow shows up. This could be
intentional, but also ...
- [x] The headings look like links, and when I hover the underline goes
away, but its not actually clickable.
On mobile:
- [ ] The contributing code section only collapses to down to "To install
these in a debian-based distribution"
- [ ] Clicking the arrows to expand has no effect
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
Can you confirm that these expand buttons are working as intended? The
behavior seems odd to me.
On desktop:
- [x] Content is always expanded, no arrow shows up. This could be
intentional, but also ...
- [x] The headings look like links, and when I hover the underline goes
away, but its not actually clickable.
On mobile:
- [ ] The contributing code section only collapses to down to "To install
these in a debian-based distribution"
- [ ] Clicking the arrows to expand has no effect
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
Ok the dropdown buttons work better on desktop now. They still seem
broken on mobile though, nothing happens when I click them.
##########
File path: website/www/site/static/js/copy-to-clipboard.js
##########
@@ -0,0 +1,42 @@
+// 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.
+
+$(document).ready(function() {
+ function copy() {
+ $(".copy").click(function(){
+ var
text=$(this).siblings()[$(this).siblings().length-1].childNodes[0].innerHTML;
+ const el=document.createElement('textarea');
+ el.value=text;document.body.appendChild(el);
+ el.select();document.execCommand('copy');
+ document.body.removeChild(el);
+ alert('copied to clipboard');
+ })
+ $(".just-copy").click(function(){
+ var text=$(this).parent().siblings()[0].innerHTML;
+ const el=document.createElement('textarea');
+ el.value=text;document.body.appendChild(el);
+ el.select();document.execCommand('copy');
+ document.body.removeChild(el);
+ alert('copied to clipboard');
Review comment:
This alert is strange to me. It's weird to have to click "OK" after
copying.
Other implementations of this usually pop up a notification to let you know
the content has been copied, but you don't have to acknowledge it. If it's too
much to address this right now let's file a jira about it.
##########
File path: website/www/site/data/en/committer_traits.yaml
##########
@@ -0,0 +1,21 @@
+# 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.
+
+- body: { text: To learn more see the ASF documentation., link:
https://www.apache.org/foundation/policies/conduct.html }
+ bolded: Knows, upholds, and reinforces the Apache Software Foundation code
of conduct.
+ icon: icons/contributor/become a committer/messages-icon.svg
+- body: { text: To learn more see the ASF documentation., link:
https://infra.apache.org/committers.html#committer-responsibilities }
+ bolded: Knows, upholds, and reinforces the responsibilities of an Apache
Software Foundation committer.
+ icon: icons/contributor/become a committer/beam-logo-icon.svg
+- body: { text: To learn more see our best practices!, link:
https://beam.apache.org/contribute/become-a-committer/ }
Review comment:
become-a-committer is the page that this is displayed on. I think this
link should be /attributes/?
This seems a little backwards again.. but that is a design question for
@griscz
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
+
+## Overview
+
+</a>
+
+<div class="collapse dont-collapse-sm" id="collapseOverview">
-The Apache Beam community welcomes contributions from anyone!
+There are lots of opportunities to contribute. You can for example:
-If you have questions, please [reach out to the Beam
community](/contribute/get-help).
+* ask or answer questions on [[email protected]](/community/contact-us/) or
+ [stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
+* review proposed design ideas on
[[email protected]](/community/contact-us/)
+* file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
+* review [changes](https://github.com/apache/beam/pulls)
+* work on the core programming model (what is a Beam pipeline and how does it
+ run?)
+* improve the developer experience (for example, Windows guides)
+* organize local meetups of users or contributors to Apache Beam
-There are lots of opportunities to contribute:
+...and many more. Most importantly, if you have an idea of how to contribute,
then do it!
Review comment:
This is still not rendering correctly, I think we should just remove the
"... and many more" unless you know what's going wrong here.
##########
File path: website/www/site/static/js/copy-to-clipboard.js
##########
@@ -0,0 +1,42 @@
+// 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.
+
+$(document).ready(function() {
+ function copy() {
+ $(".copy").click(function(){
+ var
text=$(this).siblings()[$(this).siblings().length-1].childNodes[0].innerHTML;
+ const el=document.createElement('textarea');
+ el.value=text;document.body.appendChild(el);
+ el.select();document.execCommand('copy');
+ document.body.removeChild(el);
+ alert('copied to clipboard');
+ })
+ $(".just-copy").click(function(){
+ var text=$(this).parent().siblings()[0].innerHTML;
+ const el=document.createElement('textarea');
+ el.value=text;document.body.appendChild(el);
+ el.select();document.execCommand('copy');
+ document.body.removeChild(el);
+ alert('copied to clipboard');
Review comment:
This alert is strange to me. It's weird to have to click "OK" after
copying.
Other implementations of this sort of featureu usually pop up a notification
to let you know the content has been copied, but you don't have to acknowledge
it. If it's too much to address this right now let's file a jira about it.
##########
File path: website/www/site/content/en/blog/beam-2.22.0.md
##########
@@ -18,7 +18,7 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
We are happy to present the new 2.22.0 release of Beam. This release includes
both improvements and new functionality.
-See the [download page](/get-started/downloads/#2220-2020-06-08) for this
release.<!--more-->
+See the [download page](/get-started/downloads/#2220-2020-06-08) for this
release.
Review comment:
This looks good now, thank you
##########
File path: website/www/site/static/js/copy-to-clipboard.js
##########
@@ -0,0 +1,42 @@
+// 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.
+
+$(document).ready(function() {
+ function copy() {
+ $(".copy").click(function(){
+ var
text=$(this).siblings()[$(this).siblings().length-1].childNodes[0].innerHTML;
+ const el=document.createElement('textarea');
+ el.value=text;document.body.appendChild(el);
+ el.select();document.execCommand('copy');
+ document.body.removeChild(el);
+ alert('copied to clipboard');
+ })
+ $(".just-copy").click(function(){
+ var text=$(this).parent().siblings()[0].innerHTML;
+ const el=document.createElement('textarea');
+ el.value=text;document.body.appendChild(el);
+ el.select();document.execCommand('copy');
+ document.body.removeChild(el);
+ alert('copied to clipboard');
Review comment:
Ok let's just file a jira for now
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
Can you confirm that these expand buttons are working as intended? The
behavior seems odd to me.
On desktop:
- [x] Content is always expanded, no arrow shows up. This could be
intentional, but also ...
- [x] The headings look like links, and when I hover the underline goes
away, but its not actually clickable.
On mobile:
- [ ] The contributing code section only collapses to down to "To install
these in a debian-based distribution"
- [x] Clicking the arrows to expand has no effect
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
Ok the dropdowns seem to be working now. But the second one still only
collapses down to "To install these in a debian-based distribution", which
doesn't seem correct. That's still part of the Contributing Code section
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
Ok the dropdowns seem to be working now. But the second one still only
collapses down to "To install these in a debian-based distribution", which
doesn't seem correct. That's still part of the Contributing Code section
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
It looks like there's a <div> that just needs to be moved lower.
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
It looks like there's a `</div>` that just needs to be moved lower.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
