You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "Taragolis (via GitHub)" <gi...@apache.org> on 2023/12/20 07:56:34 UTC

[PR] Remove notifiers compatibility note [airflow]

Taragolis opened a new pull request, #36323:
URL: https://github.com/apache/airflow/pull/36323

   <!--
    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.
    -->
   
   <!--
   Thank you for contributing! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of an existing issue, reference it using one of the following:
   
   closes: #ISSUE
   related: #ISSUE
   
   How to write a good git commit message:
   http://chris.beams.io/posts/git-commit/
   -->
   
   Providers has min Airflow version 2.6.0, so we could remove redundant note from the documentation
   
   > [!IMPORTANT]  
   > This feature is only available in Airflow versions >= 2.6.0
   
   <!-- Please keep an empty line above the dashes. -->
   ---
   **^ Add meaningful description above**
   Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
   In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
   


-- 
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


Re: [PR] Remove notifiers compatibility note [airflow]

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #36323:
URL: https://github.com/apache/airflow/pull/36323


-- 
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


Re: [PR] Remove notifiers compatibility note [airflow]

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #36323:
URL: https://github.com/apache/airflow/pull/36323#issuecomment-1864060954

   > 
   Maybe they can be reformatted to be not important, but I think we should still keep a note. Most software documentation does keep this kind of notes since it is very easy for users to land on documentation written for a later version, even if they are actually using a previous version.
   
   I think we should remove it.- we are already >= 2.6.0 in all providers anyway, and users won't be able to use it anyway if they do not have Airflow 2.6.0 and they will see it right away. I think if we assume that users can accidentally look at new documentation of provider while they are using older version of provider, we should literally comment every single new feature and docstring of evey single function added since, because users might accidentally mix the versions. Even if it will confuse some users, this will also educate them to look at the **right** version if it happens to them.


-- 
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


Re: [PR] Remove notifiers compatibility note [airflow]

Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on PR #36323:
URL: https://github.com/apache/airflow/pull/36323#issuecomment-1864035714

   Maybe they can be reformatted to be not important, but I think we should still keep a note. Most software documentation does keep this kind of notes since it is very easy for users to land on documentation written for a later version, even if they are actually using a previous version.


-- 
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


Re: [PR] Remove notifiers compatibility note [airflow]

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #36323:
URL: https://github.com/apache/airflow/pull/36323#issuecomment-1864118856

   > It is good point to improve our Core documentation for Notifiers, e.g. there is only this [page](https://airflow.apache.org/docs/apache-airflow/stable/howto/notifications.html) in How-to guides, and there is not info about version added. So I guess it is better to move this page into the Core Concepts and add "version added" as follow up.
   
   +1 


-- 
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


Re: [PR] Remove notifiers compatibility note [airflow]

Posted by "Taragolis (via GitHub)" <gi...@apache.org>.
Taragolis commented on PR #36323:
URL: https://github.com/apache/airflow/pull/36323#issuecomment-1864095959

   I think it better to remove for consistency between providers
   - Not in all providers we have this importance note, only in this 4 providers, all other listed [here](https://airflow.apache.org/docs/apache-airflow-providers/core-extensions/notifications.html) do not have.
   - For new Notifiers which would add to providers this note doesn't make any sense
   
   It is good point to improve our Core documentation for Notifiers, e.g. there is only this [page](https://airflow.apache.org/docs/apache-airflow/stable/howto/notifications.html) in How-to guides, and there is not info about version added. So I guess it is better to move this page into the Core Concepts and add "version added" as follow up. 


-- 
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