[
https://issues.apache.org/jira/browse/BEAM-11424?focusedWorklogId=525919&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-525919
]
ASF GitHub Bot logged work on BEAM-11424:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 18/Dec/20 10:13
Start Date: 18/Dec/20 10:13
Worklog Time Spent: 10m
Work Description: Jakub-Sadowski commented on a change in pull request
#13565:
URL: https://github.com/apache/beam/pull/13565#discussion_r545732808
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,57 +22,65 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+</br>
+
+<div class="arrow-lists-desktop">
+
+## Overview
-The Apache Beam community welcomes contributions from anyone!
+</br>
-If you have questions, please [reach out to the Beam
community](/contribute/get-help).
+There are lots of opportunities to contribute. You can for example:
-There are lots of opportunities to contribute:
+<div class="arrow-list">
- - 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
+- 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
-Most importantly, if you have an idea of how to contribute, then do it!
+</div>
+
+...and many more. Most importantly, if you have an idea of how to contribute,
then do it!
+
+</br>
## Contributing code
+</br>
+
Below is a tutorial for contributing code to Beam, covering our tools and
typical process in
detail.
+</br>
+
### Prerequisites
-To contribute code, you need
+<div class="arrow-list">
+
+- 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).
+</div>
Review comment:
I completely agree with that, but other choices are:
1. to change all lists globally to arrow ones, but it could be troublesome,
because in app we have lists which we don't want to look like this.
2. set arrow lists and spacings after each paragraph with one wrapper that
way we will have less ` <div>`s, but more complex classes for each html tag
3. take all lists to shortcodes and content to yamls in data folder, the
markdown file would be cleaner, but maintenance of the code would be harsher,
because to change one page we would need to change a couple of files
About number of `<br>`s, I can drop it down, adding some spacings to the
"arrow-list" class.
If we are talking about the content of pages, some are just shorter
versions, but some of them are like complete different pages like for example
"Become a Beam Committer" page, it has totally different approach, it would be
impossible to commit firstly only content to master branch and then add styles
with merge of the `website-revamp `
----------------------------------------------------------------
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]
Issue Time Tracking
-------------------
Worklog Id: (was: 525919)
Time Spent: 2h 20m (was: 2h 10m)
> [Website revamp] Development of Contribution Guide page
> -------------------------------------------------------
>
> Key: BEAM-11424
> URL: https://issues.apache.org/jira/browse/BEAM-11424
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: Agnieszka Sell
> Assignee: Jakub Sadowski
> Priority: P2
> Labels: website-revamp-2020, website-revamp-sprint-9
> Time Spent: 2h 20m
> Remaining Estimate: 0h
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
