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
Fix the broken file link #34826
Fix the broken file link #34826
Conversation
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)
|
@@ -30,7 +30,7 @@ can also customize it and configure it as you want by overriding Python logger c | |||
be configured by providing custom logging configuration object. Some configuration options require | |||
that the logging config class be overwritten. You can do it by copying the default | |||
configuration of Airflow and modifying it to suit your needs. The default configuration can be seen in the | |||
`airflow_local_settings.py template <https://github.com/apache/airflow/blob/|airflow_version|/airflow/config_templates/airflow_local_settings.py>`_ | |||
`airflow_local_settings.py template <https://github.com/apache/airflow/blob/main/airflow/config_templates/airflow_local_settings.py>`_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`airflow_local_settings.py template <https://github.com/apache/airflow/blob/main/airflow/config_templates/airflow_local_settings.py>`_ | |
`airflow_local_settings.py template <https://github.com/apache/airflow/blob/|airflow-version|/airflow/config_templates/airflow_local_settings.py>`_ |
Originally it is wrong substitution variable, however variables substitution doesn't work within the links, instead of hardcode to main
we should change it to correct one (|airflow-version|
) and add path to generated HTML (administration-and-deployment/logging-monitoring/advanced-logging-configuration.html
) into this list
Lines 333 to 337 in 153fd11
# Substitute in links | |
manual_substitutions_in_generated_html = [ | |
"installation/installing-from-pypi.html", | |
"installation/installing-from-sources.html", | |
] |
And after that better to check locally that manual substitution works fine by run Building the documentation command, and validate it locally
breeze build-docs --package-filter apache-airflow
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions. |
* fix doc link * add link to manual substitution (cherry picked from commit 609eed9)
* fix doc link * add link to manual substitution (cherry picked from commit 609eed9)
Fix the broken file link
^ 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.