Skip to content

overview.rst missing a newline which caused image to not display#69566

Open
chrispatterson wants to merge 2 commits into
apache:mainfrom
chrispatterson:patch-1
Open

overview.rst missing a newline which caused image to not display#69566
chrispatterson wants to merge 2 commits into
apache:mainfrom
chrispatterson:patch-1

Conversation

@chrispatterson

Copy link
Copy Markdown

Adding an additional newline after the last paragraph in the "Distributed Airflow architecture" section, so that the diagram_distributed_airflow_architecture.png image will be properly interpreted as an image.

(Trivial I know, but noticed while I was reading the documentation and felt like campsite rules were a good impetus to submit a fix)


Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

Adding an additional newline after the last paragraph in the "Distributed Airflow architecture" section, so that the diagram_distributed_airflow_architecture.png image will be properly interpreted as an image.
@boring-cyborg

boring-cyborg Bot commented Jul 7, 2026

Copy link
Copy Markdown

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 Contributors' Guide
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks 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

@Vamsi-klu

Copy link
Copy Markdown
Contributor

Confirmed the root cause. In RST a .. image:: directive must be separated from the preceding paragraph by a blank line; otherwise docutils folds the directive line into the paragraph and emits it as literal text instead of parsing it as an image. The paragraph ending "Helm chart is one of the ways how to deploy Airflow in K8S cluster." had no blank line before the image line, so the distributed-architecture diagram rendered as raw text. The sibling diagram_dag_processor_airflow_architecture.png directive lower in the same file already has its blank line, so this brings the two into line. Straightforward and correct.

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.

2 participants