[BEAM-13991] [Website] update contribute to beam page #17136
Conversation
|
|
||
| .list-text-size-md | ||
| li | ||
| font-size: 14px |
There was a problem hiding this comment.
Add an empty line.
|
|
||
| Apache Beam is an open source project developed and maintained by a friendly community of users, contributors, committers, and project management committee (PMC) members. | ||
|
|
||
| Everyone is welcome to join and contribute to the project in multiple ways, not only with code contributions. Contributions like asking questions, reporting bugs, proposing new features, improving documentation, adding to the website, organizing events, or writing blog posts among other contributions, are welcome and recognized. |
There was a problem hiding this comment.
| Everyone is welcome to join and contribute to the project in multiple ways, not only with code contributions. Contributions like asking questions, reporting bugs, proposing new features, improving documentation, adding to the website, organizing events, or writing blog posts among other contributions, are welcome and recognized. | |
| Everyone is welcome to join and contribute to the project in multiple ways, not only with code contributions. Contributions like asking questions, reporting bugs, proposing new features, improving documentation, adding to the website, organizing events, or writing blog posts among other contributions, are welcome and recognized. |
|
|
||
| Everyone is welcome to join and contribute to the project in multiple ways, not only with code contributions. Contributions like asking questions, reporting bugs, proposing new features, improving documentation, adding to the website, organizing events, or writing blog posts among other contributions, are welcome and recognized. | ||
|
|
||
| ### What’s In It for You? |
There was a problem hiding this comment.
| ### What’s In It for You? | |
| ### What’s In It for You? |
| ### What’s In It for You? | ||
| - Become a part of the world’s largest, most welcoming open source community | ||
| - Drive innovation for next-gen distributed data processing | ||
| - Make an impact by bringing advanced technology solutions into reality |
There was a problem hiding this comment.
| - Make an impact by bringing advanced technology solutions into reality | |
| - Make an impact by bringing advanced technology solutions into reality |
| <tr> | ||
| <td>Improve documentation</td> | ||
| <td> | ||
| Click the edit icon in our documentation and it’ll take you to our <a href="https://github.com/apache/beam/">GitHub</a>, where you can automatically make the change you want and send a Pull Request. |
There was a problem hiding this comment.
| Click the edit icon in our documentation and it’ll take you to our <a href="https://github.com/apache/beam/">GitHub</a>, where you can automatically make the change you want and send a Pull Request. | |
| Click the edit icon in our documentation and it’ll take you to our <a href="https://github.com/apache/beam/">GitHub</a>, where you can automatically make the change you want and send a Pull Request. |
| <ol> | ||
| <li>Create a Jira ticket and mark it as a feature request</li> | ||
| <br>OR<br><br> | ||
| <li>Send an email to <a href="mailto:dev@beam.apache.org">dev@beam.apache.org</a> with subject: [Feature Proposal] <your idea>.</li> |
There was a problem hiding this comment.
with subject: [Feature Proposal] <your idea>. isn't shown on the page in right way:
| “Knowledge sharing and collaboration is something that comes naturally in the community. Together, we can work with the most complex problems and just solve them. | ||
| ”Matt Casters, Co-founder @ Apache Hop |
There was a problem hiding this comment.
| “Knowledge sharing and collaboration is something that comes naturally in the community. Together, we can work with the most complex problems and just solve them. | |
| ”Matt Casters, Co-founder @ Apache Hop | |
| “Knowledge sharing and collaboration is something that comes naturally in the community. Together, we can work with the most complex problems and just solve them.” | |
| Matt Casters, Co-founder @ Apache Hop |
Matt Casters, Co-founder @ Apache Hop should be on the right side
Also need to add photo
| ”Matt Casters, Co-founder @ Apache Hop | ||
|
|
||
| “I really enjoy working with Beam. The understanding of its internals empowers you to fine-tune the open source, customize it. Beam is very powerful and the abstraction is its most significant feature.” | ||
| Talat Ulyarer, Sr Principal Software Engineer @ Palo Alto Networks |
There was a problem hiding this comment.
Talat Ulyarer, Sr Principal Software Engineer @ Palo Alto Networks should be on the right side
Also need to add photo
| Talat Ulyarer, Sr Principal Software Engineer @ Palo Alto Networks | ||
|
|
||
| “My takeaway: everyone should join the [Apache Beam] mailing lists! This is where all the discussions happen, and it is a great place for learning. I also encourage everyone to attend and participate in conferences to meet and connect with the community.” | ||
| Tobias Kaymak, Senior Data Engineer @ Ricardo |
There was a problem hiding this comment.
Tobias Kaymak, Senior Data Engineer @ Ricardo should be on the right side
Also need to add photo
| @@ -0,0 +1,389 @@ | |||
| --- | |||
There was a problem hiding this comment.
As I can see you add Beam Contribution Guide page (rewrite from previous one). Make sure that [BEAM-13992] changes are also included
There was a problem hiding this comment.
added a comment to PR description to merge 13992 first and only after that 13991
| border-radius: 50% | ||
|
|
||
| .no-bullet | ||
| list-style-type: none |
There was a problem hiding this comment.
Add an empty line.
|
|
||
| - ask or answer questions on [user@beam.apache.org](/community/contact-us/) or | ||
| [stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam) | ||
| - review proposed design ideas on [dev@beam.apache.org](/community/contact-us/) |
There was a problem hiding this comment.
Change links to full format: https....
| <td>Improve the website</td> | ||
| <td class="list-text-size-md"> | ||
| <ul> | ||
| <li>Follow the website <a href="https://beam.apache.org/contribute/">Contribution Guide</a> to make changes yourself.</li> |
There was a problem hiding this comment.
| <li>Follow the website <a href="https://beam.apache.org/contribute/">Contribution Guide</a> to make changes yourself.</li> | |
| <li>Follow the website <a href="https://beam.apache.org/contribute/get-started-contributing/">Contribution Guide</a> to make changes yourself.</li> |
| <ul> | ||
| <li>Create and contribute a custom <a href="https://beam.apache.org/documentation/programming-guide/#pipeline-io">I/O connector</a> for a specific data storage system you want to connect to, if it is not on <a href="https://beam.apache.org/documentation/io/built-in/">the I/O list yet</a>.</li> | ||
| <li>Look at our project backlog to get some inspiration on what to build.</li> | ||
| <li>Follow our <a href="https://beam.apache.org/contribute/">Code Contribution Guide</a>.</li> |
There was a problem hiding this comment.
| <li>Follow our <a href="https://beam.apache.org/contribute/">Code Contribution Guide</a>.</li> | |
| <li>Follow our <a href="https://beam.apache.org/contribute/get-started-contributing/">Code Contribution Guide</a>.</li> |
| <td>Share a code sample or template</td> | ||
| <td class="list-text-size-md"> | ||
| <ol> | ||
| <li>Read our <a href="https://beam.apache.org/contribute/">Code Contribution Guide</a>.</li> |
There was a problem hiding this comment.
| <li>Read our <a href="https://beam.apache.org/contribute/">Code Contribution Guide</a>.</li> | |
| <li>Read our <a href="https://beam.apache.org/contribute/get-started-contributing/">Code Contribution Guide</a>.</li> |
| <ol> | ||
| <li>Read our <a href="https://beam.apache.org/contribute/">Code Contribution Guide</a>.</li> | ||
| <li>Create your code sample or template. </li> | ||
| <li><a href="https://beam.apache.org/contribute/#make-your-change">Make a Pull Request</a> to add it to the Beam example folder.</li> |
There was a problem hiding this comment.
| <li><a href="https://beam.apache.org/contribute/#make-your-change">Make a Pull Request</a> to add it to the Beam example folder.</li> | |
| <li><a href="https://beam.apache.org/contribute/get-started-contributing/#make-your-change">Make a Pull Request</a> to add it to the Beam example folder.</li> |
| “Knowledge sharing and collaboration is something that comes naturally in the community. Together, we can work with the most complex problems and just solve them.” | ||
| <div class="contribute-quote-block"> | ||
| <span>Matt Casters, Co-founder @ Apache Hop</span> | ||
| <img src="https://beam.apache.org/images/matt_casters_photo.png" alt="Matt Casters"> | ||
| </div> |
There was a problem hiding this comment.
Could you please change this part like it is done on the Case Studies Page (visual)
the same for all other quotes.
|
|
||
| ## The Traits of an Apache Beam Committer | ||
|
|
||
| {{< contributor/row_of_traits committer_traits >}} |
There was a problem hiding this comment.
This section looks like:
Could we change style of the Learn more., so it looks like in Case Studies Page
|
@pcoet please take a look:) |
# Conflicts: # website/www/site/assets/scss/main.scss
|
👍 |
| <td class="list-text-size-md"> | ||
| <ul> | ||
| <li>Follow the website <a href="https://beam.apache.org/contribute/get-started-contributing/">Contribution Guide</a> to make changes yourself.</li> | ||
| <li>Check our <a href="https://issues.apache.org/jira/browse/BEAM-13229?jql=project%20%3D%20BEAM%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20website%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC">Website Backlog</a> in Jira to find rooms for improvement areas, or propose one.</li> |
There was a problem hiding this comment.
"find rooms for improvement areas" -> this doesn't quite make sense to me (?)
There was a problem hiding this comment.
@bullet03 please change to "find rooms for improvement, or propose one."
|
|
||
| Even though there is no strict protocol to become a committer, the most important thing we look for is that you display the traits of an Apache Beam committer and that you have been consistently contributing to the project and community. | ||
|
|
||
| Candidates for new committers are suggested by current committers or PMC members, and voted upon by the PMC team. So if you would like to become a committer, engage with the community and keep contributing to Apache Beam, you might also want to talk to other committers and ask for their advice and guidance. Feel free to email any committer directly and ask for their advice! |
There was a problem hiding this comment.
"Apache Beam, you might" -> "Apache Beam. You might"
|
|
||
| Since the PMC members are responsible for establishing the Apache Beam vision and leading our community to work in harmony to achieve it, we look for committed individuals who can perform the responsibilities of the PMC, as well as lead our community to fulfill its vision. This is why we strive to build a diverse PMC that complements skills and expertise sharing the same sets of values. | ||
|
|
||
| Ideally, we find candidates among active community members that have shown initiative to shape the direction of Beam and have shown willingness to learn the official processes, such as how to create or verify for releases, how to ensure trademark compliance for events, among others. We also expect PMC candidates to be level-headed, constructive, supportive, and willing to “disagree and commit” at times. |
There was a problem hiding this comment.
"verify for releases" -> "verify releases"
| 1. Clone the git repository. You can download it anywhere you like. | ||
|
|
||
| $ mkdir -p ~/go/src/github.com/apache | ||
| $ cd ~/go/src/github.com/apache |
There was a problem hiding this comment.
Can you confirm that these commands are right? I don't understand why you'd create a directory at ~/go/src/github.com/apache before cloning the repo. Unless this is something specific for Go...?
There was a problem hiding this comment.
i was confirmed, that they are correct.
There was a problem hiding this comment.
I think this should only be necessary if you're doing Go development. Also, it doesn't mention forking the repo first. I think the steps are fixed in the other PR, but please make sure...
| $ go get -u ./... | ||
|
|
||
| 1. Check the environment was set up correctly. | ||
| - **Option 1**: validate the Go, Java, and Python environments: |
There was a problem hiding this comment.
The Markdown is not rendering correctly in any of these steps.
There was a problem hiding this comment.
It is changed in PR#17098 (Beam 13992) #17089.
13992 should be merged before this PR, because it contains changes, that will be used in current PR, as it is stated in description
| export GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore | ||
| ./gradlew :sdks:go:examples:wordCount | ||
| ``` | ||
| - For **Python development**: |
There was a problem hiding this comment.
It is changed in PR#17098 (Beam 13992) #17089.
13992 should be merged before this PR, because it contains changes, that will be used in current PR, as it is stated in description
| ``` | ||
| ./gradlew :sdks:python:wordCount | ||
| ``` | ||
| - For **Java development**: |
There was a problem hiding this comment.
Please review the markdown in all of these steps. It's being treated as code, so e.g. **foo** is not rendering.
There was a problem hiding this comment.
It is changed in PR#17098 (Beam 13992) #17089.
13992 should be merged before this PR, because it contains changes, that will be used in current PR, as it is stated in description
|
@pcoet I think we implemented all your comments, the markdown is fixed in PR # 17098, thank you for the review! Can you please take another look? |
…beam-page' into BEAM-13991-update-contribute-to-beam-page # Conflicts: # website/www/site/content/en/contribute/_index.md
bullet03
changed the title
bullet03
changed the title
# Conflicts: # website/www/site/content/en/contribute/_index.md
[BEAM-13991]
NB!!! Firstly, PR #17089 ([BEAM-13992]) is needed to be merged, because it contains changes that will be used in current PR.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
R: @username).[BEAM-XXX] Fixes bug in ApproximateQuantiles, where you replaceBEAM-XXXwith the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI.