Skip to content

Document how our documentation works #50464

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

Merged

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented May 11, 2025

This is high-level description of the architecture and workflows of our documentation building and publishing.


^ 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 airflow-core/newsfragments.

@potiuk
Copy link
Member Author

potiuk commented May 11, 2025

We still have few todos:

  • complete staging setup - we have to setup staging website via .asf.yaml (but we need to know what's up wiht the proxy refreshing) - I do not want to mess-around with .asf.yaml until https://issues.apache.org/jira/browse/INFRA-26814 is solved.

  • we need to automate running syncing of changes from live bucket to main of apache-airflow-site-archive - for now we manually sync those, but we need to either trigger them or schedule syncing in pull mode (The latter is likely a bit better as it will not need PAT to be stored as secret).

But this one generally describes the flows that we will have once this is complete.

Copy link
Member

@gopidesupavan gopidesupavan left a comment

Choose a reason for hiding this comment

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

nice explanation :)

@potiuk potiuk force-pushed the update-documentation-about-building-documentation branch from a30e95e to 2cdfb1a Compare May 11, 2025 20:30
@potiuk
Copy link
Member Author

potiuk commented May 11, 2025

I also added description on how to manually do the same without GitHub Actions.

@potiuk potiuk force-pushed the update-documentation-about-building-documentation branch from 2cdfb1a to 8c28e6c Compare May 11, 2025 21:44
Copy link
Contributor

@ephraimbuddy ephraimbuddy left a comment

Choose a reason for hiding this comment

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

This is nice!

@potiuk potiuk force-pushed the update-documentation-about-building-documentation branch 2 times, most recently from 57ba2fa to 3ba6c6e Compare May 12, 2025 15:18
@potiuk potiuk requested a review from pierrejeambrun as a code owner May 12, 2025 15:18
@potiuk potiuk linked an issue May 12, 2025 that may be closed by this pull request
1 task
This is high-level description of the architecture and workflows
of our documentation building and publishing.
@potiuk potiuk force-pushed the update-documentation-about-building-documentation branch from 3ba6c6e to fd7dae2 Compare May 12, 2025 15:49
@potiuk
Copy link
Member Author

potiuk commented May 12, 2025

Updated latest comments @eladkal

Copy link
Contributor

@eladkal eladkal left a comment

Choose a reason for hiding this comment

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

Very cool!

@potiuk potiuk merged commit 9a76e11 into apache:main May 12, 2025
52 checks passed
@potiuk potiuk deleted the update-documentation-about-building-documentation branch May 12, 2025 17:03
sanederchik pushed a commit to sanederchik/airflow that referenced this pull request Jun 7, 2025
This is high-level description of the architecture and workflows
of our documentation building and publishing.
@potiuk potiuk mentioned this pull request Jun 17, 2025
2 tasks
jedcunningham added a commit to astronomer/airflow that referenced this pull request Jun 24, 2025
This was removed in apache#50464, but we still need to do this step.
jedcunningham added a commit that referenced this pull request Jun 24, 2025
This was removed in #50464, but we still need to do this step.
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.

Document our doc architecture with diagrams and flows
5 participants