Restructure Docs #27235
Merged
Restructure Docs #27235
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TohnJhomas
requested review from
jedcunningham,
dstandish,
uranusjr,
kaxil and
potiuk
as code owners
boring-cyborg
bot
added
area:core-operators
|
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)
|
|
This version has known issues with cross-provider label referencing |
|
Thanks for taking the time to do this! The new structure makes much more sense to me. |
I second this emotion. Thanks |
|
Conflicts to resolve I am avraid :( . Emotions are the same :) |
|
Would be great also if you generate the docs |
|
Looking forward to this much-needed change! 👍 |
Likewise. |
|
Can you also update the |
|
Yeah - just pointing all the old locations at their new locations? |
|
@TohnJhomas Yes. Exactly. |
|
has conflicts |
|
@TohnJhomas I'd love to see this PR merged, any chance you could resolve the conflicts? |
Oh yeah. I would very, very much love that too. Maybe you need some help @TohnJhomas ? I am happy to spend some time on helping to solve issue with docs building (I know it is a very daunting thing to fight with Sphinx. The way the tags etc. are defined are rather non-intuitive and there are many, many traps you can fall in. |
|
Approved workflow again :) |
potiuk
approved these changes
Dec 16, 2022
|
🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 Let me merge it quickly before there are any conflicts 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 🎉 |
|
Awesome work, congrats on your first merged pull request! |
gschuurman
pushed a commit
to gschuurman/airflow
that referenced
this pull request
Dec 19, 2022
A big restructuring of our docs to make them easier to reason about - in a much more logical and consistent way. Likel other updates and content changes will be needed to make it even better.
84 tasks
2 tasks
ephraimbuddy
pushed a commit
that referenced
this pull request
Jan 12, 2023
A big restructuring of our docs to make them easier to reason about - in a much more logical and consistent way. Likel other updates and content changes will be needed to make it even better. (cherry picked from commit 401fc57)
ephraimbuddy
added a commit
that referenced
this pull request
Jan 12, 2023
raboof
added a commit
to raboof/airflow
that referenced
this pull request
Apr 24, 2023
Add a broad-strokes description of the security expectations operator should expect. This will get included into https://airflow.apache.org/docs/apache-airflow/stable/administration-and-deployment/security/index.html I'm no Airflow expert so help definitely welcome. I would like this section to be a bit more prominent rather than hidden away under 'Administration and Deployment', but it looks like the structure was carefully considered in apache#27235 so this is probably fine. Eventually we could point the 'Security' link on the main pages like https://airflow.apache.org/ to this page.
ashb
pushed a commit
that referenced
this pull request
Apr 25, 2023
Add a broad-strokes description of the security expectations operator should expect. This will get included into https://airflow.apache.org/docs/apache-airflow/stable/administration-and-deployment/security/index.html I'm no Airflow expert so help definitely welcome. I would like this section to be a bit more prominent rather than hidden away under 'Administration and Deployment', but it looks like the structure was carefully considered in #27235 so this is probably fine. Eventually we could point the 'Security' link on the main pages like https://airflow.apache.org/ to this page.
eladkal
pushed a commit
that referenced
this pull request
Jun 8, 2023
Add a broad-strokes description of the security expectations operator should expect. This will get included into https://airflow.apache.org/docs/apache-airflow/stable/administration-and-deployment/security/index.html I'm no Airflow expert so help definitely welcome. I would like this section to be a bit more prominent rather than hidden away under 'Administration and Deployment', but it looks like the structure was carefully considered in #27235 so this is probably fine. Eventually we could point the 'Security' link on the main pages like https://airflow.apache.org/ to this page. (cherry picked from commit f20c08a)
ahidalgob
pushed a commit
to GoogleCloudPlatform/composer-airflow
that referenced
this pull request
Jun 12, 2023
Add a broad-strokes description of the security expectations operator should expect. This will get included into https://airflow.apache.org/docs/apache-airflow/stable/administration-and-deployment/security/index.html I'm no Airflow expert so help definitely welcome. I would like this section to be a bit more prominent rather than hidden away under 'Administration and Deployment', but it looks like the structure was carefully considered in apache/airflow#27235 so this is probably fine. Eventually we could point the 'Security' link on the main pages like https://airflow.apache.org/ to this page. GitOrigin-RevId: f20c08a77c9daefe54c14c5013fcf53d84b5744d
ahidalgob
pushed a commit
to GoogleCloudPlatform/composer-airflow
that referenced
this pull request
Nov 7, 2023
Add a broad-strokes description of the security expectations operator should expect. This will get included into https://airflow.apache.org/docs/apache-airflow/stable/administration-and-deployment/security/index.html I'm no Airflow expert so help definitely welcome. I would like this section to be a bit more prominent rather than hidden away under 'Administration and Deployment', but it looks like the structure was carefully considered in apache/airflow#27235 so this is probably fine. Eventually we could point the 'Security' link on the main pages like https://airflow.apache.org/ to this page. (cherry picked from commit f20c08a77c9daefe54c14c5013fcf53d84b5744d) GitOrigin-RevId: bb86b468ae9396ece41f105db6104ee9282b4ed1
ahidalgob
pushed a commit
to GoogleCloudPlatform/composer-airflow
that referenced
this pull request
May 15, 2024
Add a broad-strokes description of the security expectations operator should expect. This will get included into https://airflow.apache.org/docs/apache-airflow/stable/administration-and-deployment/security/index.html I'm no Airflow expert so help definitely welcome. I would like this section to be a bit more prominent rather than hidden away under 'Administration and Deployment', but it looks like the structure was carefully considered in apache/airflow#27235 so this is probably fine. Eventually we could point the 'Security' link on the main pages like https://airflow.apache.org/ to this page. GitOrigin-RevId: f20c08a77c9daefe54c14c5013fcf53d84b5744d
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is designed to restructure the overcrowded and confusing sidebar of the Astronomer Documentation. This is intended to allow for further scalability of the airflow docs, and to increase user-friendliness to new users.
The current docs have 28 top-level pages and two sub-sections of substance: "How-to Guides" and "Concepts." Here I've attempted to clean up the sidebar and make the structure more clear by both splitting "Concepts" into three new top-level pages ("Core Concepts," "Authoring and Scheduling" and "Administration and Deployment") and folding many of the current top-level pages into these categories.
The structure of the docs as they currently are is visually here: The left column is representative of the top-level sidebar, with the concepts subsection broken out to the right. How-to guides is another large section, but because it didn't undergo any substantial change I've hidden the sub-pages for ease of understanding.
The structure of the refactored docs is below, with the same format as above: