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

Fix the broken file link #34826

Merged
merged 4 commits into from Oct 10, 2023
Merged

Fix the broken file link #34826

merged 4 commits into from Oct 10, 2023

Conversation

guoshiqi0830
Copy link
Contributor

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.

@boring-cyborg
Copy link

boring-cyborg bot commented Oct 9, 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

@@ -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>`_
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`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

airflow/docs/conf.py

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The manual subsitution works fine in my local env.

image

@Taragolis Taragolis merged commit 609eed9 into apache:main Oct 10, 2023
43 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 10, 2023

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

@guoshiqi0830 guoshiqi0830 deleted the fix-doc-link branch October 10, 2023 10:27
@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
* fix doc link

* add link to manual substitution

(cherry picked from commit 609eed9)
ephraimbuddy pushed a commit that referenced this pull request Oct 30, 2023
* fix doc link

* add link to manual substitution

(cherry picked from commit 609eed9)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants