TheNeuralBit commented on a change in pull request #13511: URL: https://github.com/apache/beam/pull/13511#discussion_r568689716
########## File path: website/www/site/data/en/community_list.yaml ########## @@ -0,0 +1,27 @@ +# 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. + +- title: { text: Join Beam Community, link: /community/join-beam } + body: Here you will find real life cases. + icon: icons/community/bee-icon.svg +- title: { text: Contact us!, link: /community/contact-us } + body: You want to know what is going on? Raise a bug? Propose a feature request? Here you will find all of them info all of the info on who to contact. + icon: icons/community/envelope-icon.svg +- title: { text: Keep up with Beam, link: / } + body: Check out our social media and be first to know about any updates. + icon: icons/community/message-icon.svg +- title: { text: Meet up with us!, link: / } + body: Want to meet us in person? (or monitor-person). This is the place to go. + icon: icons/community/calendar-icon.svg +- title: { text: Promotion, link: / } + body: Need some marketing materials? Here you will find it all. + icon: icons/community/box-icon.svg Review comment: A couple of problems with this file: - It looks like the copy in it wasn't updated in the last commit. Is this something you're still waiting on? - The links for the last three items are `/` should they point somewhere else? Please add a TODO if we need to update these later. - The link for the first item, /community/join-beam, doesn't exist. Maybe it's added in another PR? Or is this link just incorrect? ########## File path: website/www/site/content/en/community/contact-us.md ########## @@ -20,28 +21,29 @@ See the License for the specific language governing permissions and limitations under the License. --> -# Contact Us +# Contact us! + +The Apache Beam community is friendly and welcoming. We are glad to help with any +question, suggestion or idea you have. Contact us in the following channels: + +## Available contact channels + +{{< community/table_with_icons contact_us >}} + +## Mailing list, what are they and how they work + +The official communication channels for Apache projects are their mailing lists, and Apache Beam has two main lists: [[email protected]]([email protected]) and [[email protected]]([email protected]). The topics for each of them can be seen in the section above. -There are many ways to reach the Beam user and developer communities - use -whichever one seems best. +### Subsribe and Unsubscribe: -<!-- We use div instead of table shortcode here, because markdownify break superscripts --> -<div class="table-wrapper"> +Prior to sending emails to these lists, you need to subscribe. To subscribe, send a blank email to [[email protected]]([email protected]) or [[email protected]]([email protected]) depending on the list you want to write to. -| How to contact us | When to use it | -| ----------------- | ---------------| -| [user@](https://lists.apache.org/[email protected]) mailing list | User support and questions ([Subscribe](mailto:[email protected])[^1], [Unsubscribe](mailto:[email protected])[^1], [Archives](https://lists.apache.org/[email protected])) | -| [dev@](https://lists.apache.org/[email protected]) mailing list | Development discussions ([Subscribe](mailto:[email protected])[^1], [Unsubscribe](mailto:[email protected])[^1], [Archives](https://lists.apache.org/[email protected])) | -| [commits@](https://lists.apache.org/[email protected]) mailing list | Firehose of commits, bugs, pull requests, etc. ([Subscribe](mailto:[email protected])[^1], [Unsubscribe](mailto:[email protected])[^1], [Archives](https://lists.apache.org/[email protected])) | -| [builds@](https://lists.apache.org/[email protected]) mailing list | Firehose of build notifications from Jenkins ([Subscribe](mailto:[email protected])[^1], [Unsubscribe](mailto:[email protected])[^1], [Archives](https://lists.apache.org/[email protected])) | -| [JIRA bug tracker](https://issues.apache.org/jira/browse/BEAM) | Report bugs / discover known issues | -| [StackOverflow](https://stackoverflow.com/questions/tagged/apache-beam) | Ask and answer user support questions | -| [Slack](https://s.apache.org/beam-slack-channel) | Chat with users and developers in the ASF Slack. Note: Please [join the #beam channel](https://s.apache.org/beam-slack-channel) after you [created an account](https://s.apache.org/slack-invite). Please do not ask Beam questions in #general. | +### Useful Tips for Sending Emails -</div> +Tip 1: Use tags in your subject line. +A tag is a word within a pair of brackets [] that indicate the type of message you’re sending. For example: [Bug] or [Proposal] or [Question] or [Idea]. Tags help folks navigate emails easier. -If you have questions about how to use Apache Beam, we recommend you try out the [user@](https://lists.apache.org/[email protected]) mailing list, and [StackOverflow](https://stackoverflow.com/questions/tagged/apache-beam). +Tip 2: If you’re asking a troubleshooting question, provide as much information as possible to help others replicate your issue or find possible solutions. -[^1]: To subscribe or unsubscribe, a blank email is fine. +Tip 3: Share complete links instead of hyperlinks. A common practice in Apache is adding a number tag like [1] to indicate a word is a link or an attachment, and use the ta as a footnote to add the complete link at the end of your message. Review comment: Minor typo: ```suggestion Tip 3: Share complete links instead of hyperlinks. A common practice in Apache is adding a number tag like [1] to indicate a word is a link or an attachment, and use the tag as a footnote to add the complete link at the end of your message. ``` ########## File path: website/www/site/content/en/community/_index.md ########## @@ -0,0 +1,28 @@ +--- +title: "Community Beam" +aliases: + - /use/issue-tracking/ + - /use/mailing-lists/ + - /get-started/support/ +--- + +<!-- +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. +--> + +# Welcome to the Beam Community! + +Beam is a tool created by community for community. We tirelessly work to make it better and you can do it too! +If you are a data or software developer this is a place for you. + +{{< community/list_with_icons community_list >}} Review comment: This copy also wasn't updated in the last commit. Is this the final copy, or are we still waiting on it? ---------------------------------------------------------------- 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]
