Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to enable test connection #34905

Merged
merged 11 commits into from Oct 16, 2023

Conversation

vatsrahul1001
Copy link
Collaborator

with PR now testing connections is disabled by default, few docs were not updated with that information this PR is to update docs

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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.

@boring-cyborg boring-cyborg bot added area:UI Related to UI/UX. For Frontend Developers. area:webserver Webserver related Issues kind:documentation labels Oct 13, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 13, 2023

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/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits 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 Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment 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 for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is generated from openapi/v1.yaml and you should not modify it correctly. Modify the specification file instead and use pre-commit to sync the files instead. See the contribution guide located in the repository root to learn how to set up the dev toolchain.

@potiuk
Copy link
Member

potiuk commented Oct 15, 2023

Can you please also add the disclaimers from the release notes. Something alongside this:

For security reasons, the test connection functionality is disabled by default across Airflow UI, API and CLI. 

For more information on capabilities of users, see the documentation: 
https://airflow.apache.org/docs/apache-airflow/stable/security/security_model.html#capabilities-of-authenticated-ui-users.
It is strongly advised to not enable the feature until you make sure that only
highly trusted UI/API users have “edit connection” permissions.

vatsrahul1001 and others added 2 commits October 16, 2023 10:57
Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>
Comment on lines 369 to 372
description: |
Test a connection.
Testing Connections is disabled by default set test_connection flag to enabled in Airflow configuration (airflow.cfg).
It can also be controlled by the environment variable AIRFLOW__CORE__TEST_CONNECTION.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: |
Test a connection.
Testing Connections is disabled by default set test_connection flag to enabled in Airflow configuration (airflow.cfg).
It can also be controlled by the environment variable AIRFLOW__CORE__TEST_CONNECTION.
description: >
Test a connection.
Testing Connections is disabled by default set test_connection flag to enabled in Airflow configuration (airflow.cfg).
It can also be controlled by the environment variable `AIRFLOW__CORE__TEST_CONNECTION`.

This fixes the rendering issues in the generated ts comment. (Don’t apply this on GitHub, you need to do this locally to go through pre-commit)

@uranusjr
Copy link
Member

Did you forget to run the changes through pre-commit?

@vatsrahul1001
Copy link
Collaborator Author

vatsrahul1001 commented Oct 16, 2023

Did you forget to run the changes through pre-commit?

I did run pre-commit, let me check again

docs/apache-airflow/howto/connection.rst Outdated Show resolved Hide resolved
docs/apache-airflow/howto/connection.rst Outdated Show resolved Hide resolved
docs/apache-airflow/howto/connection.rst Outdated Show resolved Hide resolved
Copy link
Member

@uranusjr uranusjr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pending CI

@potiuk potiuk merged commit ad15af5 into apache:main Oct 16, 2023
43 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 16, 2023

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@ephraimbuddy ephraimbuddy added the type:doc-only Changelog: Doc Only label Oct 27, 2023
@ephraimbuddy ephraimbuddy added this to the Airflow 2.7.3 milestone Oct 27, 2023
ephraimbuddy pushed a commit that referenced this pull request Oct 29, 2023
---------

Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
(cherry picked from commit ad15af5)
ephraimbuddy pushed a commit that referenced this pull request Oct 30, 2023
---------

Co-authored-by: Pankaj Koti <pankajkoti699@gmail.com>
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
(cherry picked from commit ad15af5)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:UI Related to UI/UX. For Frontend Developers. area:webserver Webserver related Issues kind:documentation type:doc-only Changelog: Doc Only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants