You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/02/10 16:28:52 UTC
[GitHub] [airflow] paolaperaza opened a new pull request #14176: Simplify CONTRIBUTING.rst
paolaperaza opened a new pull request #14176:
URL: https://github.com/apache/airflow/pull/14176
This is a draft PR that seeks to simplify Airflow's [CONTRIBUTING.rst](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst).
Specifically, this PR:
- Removes most sections under "Contributions" to a single "Welcome" section
- Simplifies the overview "Contribution Workflow" to actually match the steps provided
Will continue working on this based on the next steps we've been working on here and update this PR description as needed: https://docs.google.com/document/d/19y8AfZ56mvIo1AjxoFz0Ebzj_9VQJ6YTr0Acj64W1L4/edit
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] paolaperaza commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-832761480
@kaxil @potiuk @vikramkoka A bit delayed here, but I THINK this PR is finally ready for review π My latest changes include:
- Pulling in most recent commits to `contributing.rst` (since I changed the file name, I couldn't rebase and merge).
- Wrote new content for `contribute-docs.rst`
**Question:**
Did we want to pull in @marcosmarxm changes to my new `contribute-providers.rst` file, or keep that file under the `apache-airflow-providers` directory? His currently lives here: https://github.com/apache/airflow/blob/932f8c2e9360de6371031d4d71df00867a2776e6/docs/apache-airflow-providers/howto/create-update-providers.rst
The `contribute-providers.rst` file that I created was really just extracting provider-related info from the original `contributing.rst`. I could also just delete it?
Let me know what you two think so we can keep the ball moving. Appreciate 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:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] closed pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed pull request #14176:
URL: https://github.com/apache/airflow/pull/14176
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] paolaperaza edited a comment on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza edited a comment on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-832761480
@kaxil @potiuk @vikramkoka A bit delayed here, but I THINK this PR is finally ready for review π My latest changes include:
- Pulling in [most recent commits](https://github.com/apache/airflow/commits/master/CONTRIBUTING.rst) to `contributing.rst` (since I changed the file name, I couldn't rebase and merge).
- Wrote new content for `contribute-docs.rst`
**Question:**
Did we want to pull in @marcosmarxm changes to my new `contribute-providers.rst` file, or keep that file under the `apache-airflow-providers` directory? His currently lives here: https://github.com/apache/airflow/blob/932f8c2e9360de6371031d4d71df00867a2776e6/docs/apache-airflow-providers/howto/create-update-providers.rst
The `contribute-providers.rst` file that I created was really just extracting provider-related info from the original `contributing.rst`. I could also just delete it?
Let me know what you two think so we can keep the ball moving. Appreciate 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:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] closed pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed pull request #14176:
URL: https://github.com/apache/airflow/pull/14176
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-811276689
Cool!
--
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:
users@infra.apache.org
[GitHub] [airflow] paolaperaza commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-839083636
@potiuk Thanks for looking at this! Just rebased and resolved some conflicts with `contributing.rst`, so I should be back in a clean working state for now. Do you wanna review my proposed changes in aggregate now and let me know what you think?
--
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:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
uranusjr commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-809718513
Would it be worthwhile to still have a `CONTRIBUTING` file? I think GitHub detects this particular file name and displays it in new PRs. https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors#adding-a-contributing-file
--
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:
users@infra.apache.org
[GitHub] [airflow] paolaperaza commented on a change in pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza commented on a change in pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#discussion_r632773459
##########
File path: contribute/CONTRIBUTE-PROVIDERS.rst
##########
@@ -0,0 +1,293 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+.. contents:: :local:
+
+Overview of Airflow Dependencies
+====================
+
+.. note::
+
+ On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
+ might work with Apache Airflow as of 20.3.3, but it might lead to errors in installation. It might
+ depend on your choice of extras. In order to install Airflow you might need to either downgrade
+ pip to version 20.2.4 ``pip install --upgrade pip==20.2.4`` or, in case you use Pip 20.3,
+ you need to add option ``--use-deprecated legacy-resolver`` to your pip install command.
+
+ While ``pip 20.3.3`` solved most of the ``teething`` problems of 20.3, this note will remain here until we
+ set ``pip 20.3`` as official version in our CI pipeline where we are testing the installation as well.
+ Due to those constraints, only ``pip`` installation is currently officially supported.
+
+ While they are some successes with using other tools like `poetry <https://python-poetry.org/>`_ or
+ `pip-tools <https://pypi.org/project/pip-tools/>`_, they do not share the same workflow as
+ ``pip`` - especially when it comes to constraint vs. requirements management.
+ Installing via ``Poetry`` or ``pip-tools`` is not currently supported.
+
+ If you wish to install airflow using those tools you should use the constraint files and convert
+ them to appropriate format and workflow that your tool requires.
+
+
+Extras
+------
+
+There are a number of extras that can be specified when installing Airflow. Those
+extras can be specified after the usual pip install - for example
+``pip install -e .[ssh]``. For development purpose there is a ``devel`` extra that
+installs all development dependencies. There is also ``devel_ci`` that installs
+all dependencies needed in the CI environment.
+
+This is the full list of those extras:
+
+ .. START EXTRAS HERE
Review comment:
Oh good call @potiuk - wouldn't have seen that. Done!
--
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:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on a change in pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#discussion_r632283362
##########
File path: contribute/CONTRIBUTE-PROVIDERS.rst
##########
@@ -0,0 +1,293 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+.. contents:: :local:
+
+Overview of Airflow Dependencies
+====================
+
+.. note::
+
+ On November 2020, new version of PIP (20.3) has been released with a new, 2020 resolver. This resolver
+ might work with Apache Airflow as of 20.3.3, but it might lead to errors in installation. It might
+ depend on your choice of extras. In order to install Airflow you might need to either downgrade
+ pip to version 20.2.4 ``pip install --upgrade pip==20.2.4`` or, in case you use Pip 20.3,
+ you need to add option ``--use-deprecated legacy-resolver`` to your pip install command.
+
+ While ``pip 20.3.3`` solved most of the ``teething`` problems of 20.3, this note will remain here until we
+ set ``pip 20.3`` as official version in our CI pipeline where we are testing the installation as well.
+ Due to those constraints, only ``pip`` installation is currently officially supported.
+
+ While they are some successes with using other tools like `poetry <https://python-poetry.org/>`_ or
+ `pip-tools <https://pypi.org/project/pip-tools/>`_, they do not share the same workflow as
+ ``pip`` - especially when it comes to constraint vs. requirements management.
+ Installing via ``Poetry`` or ``pip-tools`` is not currently supported.
+
+ If you wish to install airflow using those tools you should use the constraint files and convert
+ them to appropriate format and workflow that your tool requires.
+
+
+Extras
+------
+
+There are a number of extras that can be specified when installing Airflow. Those
+extras can be specified after the usual pip install - for example
+``pip install -e .[ssh]``. For development purpose there is a ``devel`` extra that
+installs all development dependencies. There is also ``devel_ci`` that installs
+all dependencies needed in the CI environment.
+
+This is the full list of those extras:
+
+ .. START EXTRAS HERE
Review comment:
We also need to make one CODE change here. this document gets automatically updated whenever extras are added, so you also need to change name of the file here:
https://github.com/apache/airflow/blob/master/scripts/ci/pre_commit/pre_commit_insert_extras.py#L62
From `CONTRIBUTING.rst` to `CONTRIBUTE-PROVIDERS.rst`
--
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:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-897241593
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-834219368
> Did we want to pull in @marcosmarxm changes to my new `contribute-providers.rst` file, or keep that file under the `apache-airflow-providers` directory? His currently lives here: https://github.com/apache/airflow/blob/932f8c2e9360de6371031d4d71df00867a2776e6/docs/apache-airflow-providers/howto/create-update-providers.rst
I think let's merge yours first and the we can as @marcosmarxm to rebase his changes n top.
--
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:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on a change in pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#discussion_r632281953
##########
File path: contribute/CONTRIBUTE-DOCS.rst
##########
@@ -0,0 +1,294 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+.. contents:: :local:
+
+Overview
+========
+
+Contributing to documentation is one of the easiest and most welcome ways to improve Apache Airflow. Airflow documentation consists of the following components:
+
+- `Apache Airflow documentation <https://airflow.apache.org/docs/apache-airflow/stable/index.html>`__, which explains how to install and use Airflow.
+- `Provider documentation <https://airflow.apache.org/docs/apache-airflow-providers/index.html>`__, which explains how to connect Airflow to third-party provider packages.
+- `Helm chart documentation <https://github.com/apache/airflow/tree/master/docs/helm-chart`__, which explains how to run Airflow on Kubernetes using Helm
+- READMEs and contribution guidelines (including this page).
+- Inline docstrings, which describe functions within the source code itself.
+
+This guide provides guidance on working with docs, as well as best practices for making changes and submitting your work for review.
+
+What Should I Contribute?
+----------------------
+Do you want to contribute to Airflow docs, but you're not sure exactly where? Consider any of the following:
+
+- Typo fixes
+- Additional information about existing functionality
+- Documentation about a new feature
+- Images or screenshots that help provide users context
+- New tutorials
+
Review comment:
Actually we can do a bit better https://github.com/apache/airflow/contribute - is a dedicated GitHub link for that label + it has `CONTRIBUTING.rst" link + nice invite explaining what those issues are.
--
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:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-840897208
The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest master or amend the last commit of the PR, and push it with --force-with-lease.
--
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:
users@infra.apache.org
[GitHub] [airflow] paolaperaza commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-811092816
@potiuk @uranusjr Yes! I agree - @ashb actually suggested that at our Issue Triage meeting last week and we all agreed it was a good idea. To confirm, this means that I will:
- Keep `CONTRIBUTING.rst`, which will act as a directory to the rest of "Contributing" content (i.e. the other 3 files referenced in this PR).
- Those 3 files will be in a separate `contributing` directory (top-level)
This may be in a separate PR, but I'd also like to get the directory of that content (equivelent to CONTRIBUTING.rst) on https://airflow.apache.org/docs/, since our docs site is where most people in the community go for information. Ultimately looking to do something like [this from Ansible](https://docs.ansible.com/ansible/latest/dev_guide/index.html), but a bit more consolidated.
---
@marcosmarxm Thanks for the note! I'll comment in that PR, but I think it's fair to merge https://github.com/apache/airflow/pull/15061 before this PR, and I'll rebase and incorporate those changes here afterwards, if you all agree.
--
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:
users@infra.apache.org
[GitHub] [airflow] paolaperaza edited a comment on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza edited a comment on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-841483711
@vikramkoka @potiuk Thank you both for reviewing this! I just made both of the changes you all suggested. One last question: I did another global search on `contributing.rst` and found a lot of references to that file with a specific section. Do you all think I need to adjust those, or is it fine that we're still linking out to `contributing.rst` and people can find the info they need?
For example, our README states:
> You can read more about the naming conventions used
> in [Naming conventions for provider packages](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#naming-conventions-for-provider-packages)
Should I look through all of these and update to `CONTRIBUTE-PROVIDERS.rst` or `CONTRIBUTE-CODE.rst` etc. where appropriate? I did make that type of change in https://github.com/apache/airflow/blob/master/BREEZE.rst.
--
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:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-809782791
> Would it be worthwhile to still have a `CONTRIBUTING` file? I think [GitHub detects this particular file name and displays it in new PRs](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors).
Very good point. We should have and it should be a directory to all the split documentation.
It's also part of the "commity" checklist https://github.com/apache/airflow/community
--
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:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-834218427
Hey @paolaperaza - can you please rebase this one ? I'd love to get this one merged and will have more time to review those kind of changes now :)
--
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:
users@infra.apache.org
[GitHub] [airflow] marcosmarxm commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
marcosmarxm commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-808997561
Amazing work @paolaperaza I started to work on a how-to guide to create a new provider in #15061 (structure files, examples of initial files etc). Initially, I placed it inside the `docs/apache-airflow-providers` with other providers' documentation. Probably with this new document will be better placed together.
--
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:
users@infra.apache.org
[GitHub] [airflow] paolaperaza commented on a change in pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza commented on a change in pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#discussion_r632772102
##########
File path: contribute/CONTRIBUTE-CODE.rst
##########
@@ -0,0 +1,934 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+.. contents:: :local:
+
+Welcome
+=============
+
+Welcome to Apache Airflow! Contributions from the community are the heartbeat of the project. Every little bit helps,
+and credit will always be given.
+
+The guide below contains instructions on how to contribute to core Apache Airflow code. If you are a new contributor,
+follow `Contributors Quick Start <https://github.com/apache/airflow/blob/master/contribute/CONTRIBUTE_QUICK_START.rst>`__ first for easy, step-by-step guidelines on how to set up your development
+environment and make your first contribution.
+
+If you're interested in contributing to other parts of the project, refer to
+`Contribute to Airflow Documentation <https://github.com/apache/airflow/blob/master/contribute/CONTRIBUTE-DOCS.rst>`__ or `Contribute to Airflow Providers <https://airflow.apache.org/docs/apache-airflow-providers/index.html#creating-your-own-providers>`__.
+
+Where to Contribute
+--------------------
+To get started, decide where or what you want to contribute. For ideas, you can browse:
+
Review comment:
Good call here too - added
--
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:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on a change in pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#discussion_r632281953
##########
File path: contribute/CONTRIBUTE-DOCS.rst
##########
@@ -0,0 +1,294 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+.. contents:: :local:
+
+Overview
+========
+
+Contributing to documentation is one of the easiest and most welcome ways to improve Apache Airflow. Airflow documentation consists of the following components:
+
+- `Apache Airflow documentation <https://airflow.apache.org/docs/apache-airflow/stable/index.html>`__, which explains how to install and use Airflow.
+- `Provider documentation <https://airflow.apache.org/docs/apache-airflow-providers/index.html>`__, which explains how to connect Airflow to third-party provider packages.
+- `Helm chart documentation <https://github.com/apache/airflow/tree/master/docs/helm-chart`__, which explains how to run Airflow on Kubernetes using Helm
+- READMEs and contribution guidelines (including this page).
+- Inline docstrings, which describe functions within the source code itself.
+
+This guide provides guidance on working with docs, as well as best practices for making changes and submitting your work for review.
+
+What Should I Contribute?
+----------------------
+Do you want to contribute to Airflow docs, but you're not sure exactly where? Consider any of the following:
+
+- Typo fixes
+- Additional information about existing functionality
+- Documentation about a new feature
+- Images or screenshots that help provide users context
+- New tutorials
+
Review comment:
~Actually we can do a bit better https://github.com/apache/airflow/contribute - is a dedicated GitHub link for that label + it has `CONTRIBUTING.rst" link + nice invite explaining what those issues are.~
--
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:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-841808645
> Should I look through all of these and update to `CONTRIBUTE-PROVIDERS.rst` or `CONTRIBUTE-CODE.rst` etc. where appropriate? I did make that type of change in https://github.com/apache/airflow/blob/master/BREEZE.rst.
Absolutely. Good spot! Currently we have a major GitHub Actions outage, I hope it's going to be solved soon, but happy to review it approve and merge soon after it's finished and you update the references! https://www.githubstatus.com/incidents/zbpwygxwb3gw
--
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:
users@infra.apache.org
[GitHub] [airflow] paolaperaza edited a comment on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza edited a comment on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-811092816
@potiuk @uranusjr Yes! I agree - @ashb actually suggested that at our Issue Triage meeting last week and we all agreed it was a good idea. To confirm, this means that I will:
- Keep `CONTRIBUTING.rst`, which will act as a directory to the rest of "Contributing" content (i.e. the other 3 files referenced in this PR).
- Those 3 files will be in a separate `contributing` directory (top-level)
This may be in a separate PR, but I'd also like to get the directory of that content (equivelent to CONTRIBUTING.rst) on https://airflow.apache.org/docs/, since our docs site is where most people in the community go for information. Ultimately looking to do something like [this from Ansible](https://docs.ansible.com/ansible/latest/dev_guide/index.html), but a bit more consolidated.
---
@marcosmarxm Thanks for the note! I'll comment in that PR, but I think it's fair to merge https://github.com/apache/airflow/pull/15061 before this PR, and I'll rebase and incorporate those changes here afterwards, if you all agree.
--
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:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-776835199
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (flake8, pylint and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/master/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/master/BREEZE.rst) for testing locally, itβs a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#coding-style-and-best-practices).
Apache Airflow is a community-driven project and together we are making it better π.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [airflow] uranusjr edited a comment on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
uranusjr edited a comment on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-809718513
Would it be worthwhile to still have a `CONTRIBUTING` file? I think [GitHub detects this particular file name and displays it in new PRs](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors).
--
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:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-859686945
Yep. Will do it after @paolaperaza rebases 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:
users@infra.apache.org
[GitHub] [airflow] jhtimmins commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
jhtimmins commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-858773638
@paolaperaza can you resolve these conflicts? CI is generally stable again, so we should be able to get this merged.
@potiuk can you validate that your requested changes have been addressed?
--
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:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-841510099
[The Workflow run](https://github.com/apache/airflow/actions/runs/843334062) is cancelling this PR. Building images for the PR has failed. Follow the workflow link to check the reason.
--
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:
users@infra.apache.org
[GitHub] [airflow] paolaperaza commented on a change in pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza commented on a change in pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#discussion_r632771741
##########
File path: contribute/CONTRIBUTE-DOCS.rst
##########
@@ -0,0 +1,294 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+.. contents:: :local:
+
+Overview
+========
+
+Contributing to documentation is one of the easiest and most welcome ways to improve Apache Airflow. Airflow documentation consists of the following components:
+
+- `Apache Airflow documentation <https://airflow.apache.org/docs/apache-airflow/stable/index.html>`__, which explains how to install and use Airflow.
+- `Provider documentation <https://airflow.apache.org/docs/apache-airflow-providers/index.html>`__, which explains how to connect Airflow to third-party provider packages.
+- `Helm chart documentation <https://github.com/apache/airflow/tree/master/docs/helm-chart`__, which explains how to run Airflow on Kubernetes using Helm
+- READMEs and contribution guidelines (including this page).
+- Inline docstrings, which describe functions within the source code itself.
+
+This guide provides guidance on working with docs, as well as best practices for making changes and submitting your work for review.
+
+What Should I Contribute?
+----------------------
+Do you want to contribute to Airflow docs, but you're not sure exactly where? Consider any of the following:
+
+- Typo fixes
+- Additional information about existing functionality
+- Documentation about a new feature
+- Images or screenshots that help provide users context
+- New tutorials
+
Review comment:
Good call to add this, @vikramkoka ! Made this change in my latest commit.
--
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:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-841808645
> Should I look through all of these and update to `CONTRIBUTE-PROVIDERS.rst` or `CONTRIBUTE-CODE.rst` etc. where appropriate? I did make that type of change in https://github.com/apache/airflow/blob/master/BREEZE.rst.
Absolutely. Good spot! Currently we have a major GitHub Actions outage, I hope it's going to be solved soon, but happy to review it approve and merge soon after it's finished and you update the references! https://www.githubstatus.com/incidents/zbpwygxwb3gw
--
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:
users@infra.apache.org
[GitHub] [airflow] vikramkoka commented on a change in pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
vikramkoka commented on a change in pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#discussion_r632165140
##########
File path: contribute/CONTRIBUTE-DOCS.rst
##########
@@ -0,0 +1,294 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+.. contents:: :local:
+
+Overview
+========
+
+Contributing to documentation is one of the easiest and most welcome ways to improve Apache Airflow. Airflow documentation consists of the following components:
+
+- `Apache Airflow documentation <https://airflow.apache.org/docs/apache-airflow/stable/index.html>`__, which explains how to install and use Airflow.
+- `Provider documentation <https://airflow.apache.org/docs/apache-airflow-providers/index.html>`__, which explains how to connect Airflow to third-party provider packages.
+- `Helm chart documentation <https://github.com/apache/airflow/tree/master/docs/helm-chart`__, which explains how to run Airflow on Kubernetes using Helm
+- READMEs and contribution guidelines (including this page).
+- Inline docstrings, which describe functions within the source code itself.
+
+This guide provides guidance on working with docs, as well as best practices for making changes and submitting your work for review.
+
+What Should I Contribute?
+----------------------
+Do you want to contribute to Airflow docs, but you're not sure exactly where? Consider any of the following:
+
+- Typo fixes
+- Additional information about existing functionality
+- Documentation about a new feature
+- Images or screenshots that help provide users context
+- New tutorials
+
Review comment:
For ideas, you can browse the open identified issues:
- `All GitHub Documentation Issues <https://github.com/apache/airflow/issues?q=is%3Aopen+is%3Aissue+label%3Akind%3Adocumentation>`__
##########
File path: contribute/CONTRIBUTE-CODE.rst
##########
@@ -0,0 +1,934 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+.. contents:: :local:
+
+Welcome
+=============
+
+Welcome to Apache Airflow! Contributions from the community are the heartbeat of the project. Every little bit helps,
+and credit will always be given.
+
+The guide below contains instructions on how to contribute to core Apache Airflow code. If you are a new contributor,
+follow `Contributors Quick Start <https://github.com/apache/airflow/blob/master/contribute/CONTRIBUTE_QUICK_START.rst>`__ first for easy, step-by-step guidelines on how to set up your development
+environment and make your first contribution.
+
+If you're interested in contributing to other parts of the project, refer to
+`Contribute to Airflow Documentation <https://github.com/apache/airflow/blob/master/contribute/CONTRIBUTE-DOCS.rst>`__ or `Contribute to Airflow Providers <https://airflow.apache.org/docs/apache-airflow-providers/index.html#creating-your-own-providers>`__.
+
+Where to Contribute
+--------------------
+To get started, decide where or what you want to contribute. For ideas, you can browse:
+
Review comment:
- `Good First Issues <https://github.com/apache/airflow/issues?q=is%3Aopen+is%3Aissue+label%3A%22good%20first%20issue%22>`__
--
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:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on a change in pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#discussion_r632282284
##########
File path: contribute/CONTRIBUTE-DOCS.rst
##########
@@ -0,0 +1,294 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+.. contents:: :local:
+
+Overview
+========
+
+Contributing to documentation is one of the easiest and most welcome ways to improve Apache Airflow. Airflow documentation consists of the following components:
+
+- `Apache Airflow documentation <https://airflow.apache.org/docs/apache-airflow/stable/index.html>`__, which explains how to install and use Airflow.
+- `Provider documentation <https://airflow.apache.org/docs/apache-airflow-providers/index.html>`__, which explains how to connect Airflow to third-party provider packages.
+- `Helm chart documentation <https://github.com/apache/airflow/tree/master/docs/helm-chart`__, which explains how to run Airflow on Kubernetes using Helm
+- READMEs and contribution guidelines (including this page).
+- Inline docstrings, which describe functions within the source code itself.
+
+This guide provides guidance on working with docs, as well as best practices for making changes and submitting your work for review.
+
+What Should I Contribute?
+----------------------
+Do you want to contribute to Airflow docs, but you're not sure exactly where? Consider any of the following:
+
+- Typo fixes
+- Additional information about existing functionality
+- Documentation about a new feature
+- Images or screenshots that help provide users context
+- New tutorials
+
Review comment:
Ah no.. This is also for `kind:doc` - withdraw 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:
users@infra.apache.org
[GitHub] [airflow] paolaperaza commented on pull request #14176: Simplify CONTRIBUTING.rst
Posted by GitBox <gi...@apache.org>.
paolaperaza commented on pull request #14176:
URL: https://github.com/apache/airflow/pull/14176#issuecomment-841483711
@vikramkoka @potiuk Thank you both for reviewing this! I just made both of the changes you all suggested. One last question: I did another global search on `contributing.rst` and found a lot of references to that file with a specific section. Do you all think I need to adjust those, or is it find that we're still linking out to `contributing.rst` and people can find the info they need?
For example, our README states:
> You can read more about the naming conventions used
> in [Naming conventions for provider packages](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#naming-conventions-for-provider-packages)
Should I look through all of these and update to `CONTRIBUTE-PROVIDERS.rst` or `CONTRIBUTE-CODE.rst` etc. where appropriate?
--
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:
users@infra.apache.org