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

Add section about local settings configuration. #37829

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Mar 1, 2024

Often people see in our docs or issues/discussions that they should configure local settings, but - surprisingly - there is not a single section that explains it. Some specific configuration capabilities mention it and some even explain a bit more, but generally speaking there was not a single place where you could check what local settings are and how to configure them.

This PR changes it:

  • adds a section about it in configuration docs
  • points to this section from every place in our docs where it is mentioned you can use local settings
  • the section also links back to the places that can be configured as a set of example ways local settings can be useful.

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

Often people see in our docs or issues/discussions that they should
configure local settings, but - surprisingly - there is not a single
section that explains it. Some specific configuration capabilities
mention it and some even explain a bit more, but generally speaking
there was not a single place where you could check what local
settings are and how to configure them.

This PR changes it:

* adds a section about it in configuration docs
* points to this section from every place in our docs where it is
  mentioned you can use local settings
* the section also links back to the places that can be configured
  as a set of example ways local settings can be useful.
docs/apache-airflow/howto/set-config.rst Outdated Show resolved Hide resolved
docs/apache-airflow/howto/set-config.rst Outdated Show resolved Hide resolved
docs/apache-airflow/howto/set-config.rst Outdated Show resolved Hide resolved
potiuk and others added 3 commits March 1, 2024 18:08
Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
docs/apache-airflow/howto/set-config.rst Outdated Show resolved Hide resolved
Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
@jedcunningham jedcunningham merged commit 6ec7386 into apache:main Mar 1, 2024
55 checks passed
jedcunningham added a commit to astronomer/airflow that referenced this pull request Mar 1, 2024
potiuk pushed a commit that referenced this pull request Mar 1, 2024
abhishekbhakat pushed a commit to abhishekbhakat/my_airflow that referenced this pull request Mar 5, 2024
Often people see in our docs or issues/discussions that they should
configure local settings, but - surprisingly - there is not a single
section that explains it. Some specific configuration capabilities
mention it and some even explain a bit more, but generally speaking
there was not a single place where you could check what local
settings are and how to configure them.

This PR changes it:

* adds a section about it in configuration docs
* points to this section from every place in our docs where it is
  mentioned you can use local settings
* the section also links back to the places that can be configured
  as a set of example ways local settings can be useful.
abhishekbhakat pushed a commit to abhishekbhakat/my_airflow that referenced this pull request Mar 5, 2024
@utkarsharma2 utkarsharma2 added the type:doc-only Changelog: Doc Only label Mar 6, 2024
@utkarsharma2 utkarsharma2 added this to the Airflow 2.8.3 milestone Mar 6, 2024
ephraimbuddy pushed a commit that referenced this pull request Mar 6, 2024
Often people see in our docs or issues/discussions that they should
configure local settings, but - surprisingly - there is not a single
section that explains it. Some specific configuration capabilities
mention it and some even explain a bit more, but generally speaking
there was not a single place where you could check what local
settings are and how to configure them.

This PR changes it:

* adds a section about it in configuration docs
* points to this section from every place in our docs where it is
  mentioned you can use local settings
* the section also links back to the places that can be configured
  as a set of example ways local settings can be useful.

(cherry picked from commit 6ec7386)
ephraimbuddy pushed a commit that referenced this pull request Mar 6, 2024
This builds on what we did in #37829.

(cherry picked from commit a7691b7)
ephraimbuddy pushed a commit that referenced this pull request Mar 6, 2024
Often people see in our docs or issues/discussions that they should
configure local settings, but - surprisingly - there is not a single
section that explains it. Some specific configuration capabilities
mention it and some even explain a bit more, but generally speaking
there was not a single place where you could check what local
settings are and how to configure them.

This PR changes it:

* adds a section about it in configuration docs
* points to this section from every place in our docs where it is
  mentioned you can use local settings
* the section also links back to the places that can be configured
  as a set of example ways local settings can be useful.

(cherry picked from commit 6ec7386)
ephraimbuddy pushed a commit that referenced this pull request Mar 6, 2024
This builds on what we did in #37829.

(cherry picked from commit a7691b7)
ephraimbuddy pushed a commit that referenced this pull request Mar 6, 2024
Often people see in our docs or issues/discussions that they should
configure local settings, but - surprisingly - there is not a single
section that explains it. Some specific configuration capabilities
mention it and some even explain a bit more, but generally speaking
there was not a single place where you could check what local
settings are and how to configure them.

This PR changes it:

* adds a section about it in configuration docs
* points to this section from every place in our docs where it is
  mentioned you can use local settings
* the section also links back to the places that can be configured
  as a set of example ways local settings can be useful.

(cherry picked from commit 6ec7386)
ephraimbuddy pushed a commit that referenced this pull request Mar 6, 2024
This builds on what we did in #37829.

(cherry picked from commit a7691b7)
utkarsharma2 pushed a commit to astronomer/airflow that referenced this pull request Apr 22, 2024
Often people see in our docs or issues/discussions that they should
configure local settings, but - surprisingly - there is not a single
section that explains it. Some specific configuration capabilities
mention it and some even explain a bit more, but generally speaking
there was not a single place where you could check what local
settings are and how to configure them.

This PR changes it:

* adds a section about it in configuration docs
* points to this section from every place in our docs where it is
  mentioned you can use local settings
* the section also links back to the places that can be configured
  as a set of example ways local settings can be useful.
utkarsharma2 pushed a commit to astronomer/airflow that referenced this pull request Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants