Move apache-airflow docs to subdirectory (apache#12715)

JavierLopezT · Dec 1, 2020 · 42f0a3d · 42f0a3d
1 parent dee304b
commit 42f0a3d
Show file tree

Hide file tree

Showing 155 changed files with 64 additions and 94 deletions.
diff --git a/docs/README.rst b/docs/README.rst
@@ -22,12 +22,6 @@ This directory contains documentation for the Apache Airflow project and other p
 
 For Helm Chart, see: `/chart/README.md <../chart/READMe.md>`__
 
-File structure
-==============
-
-Currently in the ``/docs/`` directory there is documentation for the ``apache-airflow`` package. The ``apache-airflow-providers-*'` directories contains independent documentation for each provider package.
-We are taking steps to move the documentation for ``apache-airflow`` package to the ``apache-airflow`` subdirectory to make the directory structure clearer.
-
 Development documentation preview
 ==================================
 

diff --git a/docs/backport-providers.rst → docs/apache-airflow/backport-providers.rst b/docs/backport-providers.rst → docs/apache-airflow/backport-providers.rst
diff --git a/docs/best-practices.rst → docs/apache-airflow/best-practices.rst b/docs/best-practices.rst → docs/apache-airflow/best-practices.rst
diff --git a/docs/changelog.rst → docs/apache-airflow/changelog.rst b/docs/changelog.rst → docs/apache-airflow/changelog.rst
@@ -20,4 +20,4 @@
 Changelog
 =========
 
-.. include:: ../CHANGELOG.txt
+.. include:: ../../CHANGELOG.txt
diff --git a/docs/cli-and-env-variables-ref.rst → ...che-airflow/cli-and-env-variables-ref.rst b/docs/cli-and-env-variables-ref.rst → ...che-airflow/cli-and-env-variables-ref.rst
diff --git a/docs/concepts.rst → docs/apache-airflow/concepts.rst b/docs/concepts.rst → docs/apache-airflow/concepts.rst
@@ -183,7 +183,7 @@ You can also use the parameters on jinja templates by using the ``{{context.para
 
 Example DAG with decorator:
 
-.. exampleinclude:: /../airflow/example_dags/example_dag_decorator.py
+.. exampleinclude:: /../../airflow/example_dags/example_dag_decorator.py
     :language: python
     :start-after: [START dag_decorator_usage]
     :end-before: [END dag_decorator_usage]
@@ -939,14 +939,14 @@ Note that SubDAG operators should contain a factory method that returns a DAG
 object. This will prevent the SubDAG from being treated like a separate DAG in
 the main UI. For example:
 
-.. exampleinclude:: /../airflow/example_dags/subdags/subdag.py
+.. exampleinclude:: /../../airflow/example_dags/subdags/subdag.py
     :language: python
     :start-after: [START subdag]
     :end-before: [END subdag]
 
 This SubDAG can then be referenced in your main DAG file:
 
-.. exampleinclude:: /../airflow/example_dags/example_subdag_operator.py
+.. exampleinclude:: /../../airflow/example_dags/example_subdag_operator.py
     :language: python
     :start-after: [START example_subdag_operator]
     :end-before: [END example_subdag_operator]
@@ -1013,7 +1013,7 @@ and then puts both tasks upstream of ``task3``:
 
 Here is a more complicated example DAG with multiple levels of nested TaskGroups:
 
-.. exampleinclude:: /../airflow/example_dags/example_task_group.py
+.. exampleinclude:: /../../airflow/example_dags/example_task_group.py
     :language: python
     :start-after: [START howto_task_group]
     :end-before: [END howto_task_group]
@@ -1158,7 +1158,7 @@ right now is not between its ``execution_time`` and the next scheduled
 
 For example, consider the following DAG:
 
-.. exampleinclude:: /../airflow/example_dags/example_latest_only_with_trigger.py
+.. exampleinclude:: /../../airflow/example_dags/example_latest_only_with_trigger.py
     :language: python
     :start-after: [START example]
     :end-before: [END example]
@@ -1240,7 +1240,7 @@ DAG level cluster policy
 In this example we check if each DAG has at least one tag defined.
 Here is what it may look like:
 
-.. literalinclude:: /../tests/cluster_policies/__init__.py
+.. literalinclude:: /../../tests/cluster_policies/__init__.py
       :language: python
       :start-after: [START example_dag_cluster_policy]
       :end-before: [END example_dag_cluster_policy]
@@ -1252,7 +1252,7 @@ using a specific operator, or enforce a task timeout policy, making sure
 that no tasks run for more than 48 hours. Here's an example of what this
 may look like:
 
-.. literalinclude:: /../tests/cluster_policies/__init__.py
+.. literalinclude:: /../../tests/cluster_policies/__init__.py
       :language: python
       :start-after: [START example_task_cluster_policy]
       :end-before: [END example_task_cluster_policy]
@@ -1263,7 +1263,7 @@ reviewer, rather than as technical security controls.
 
 For example, don't run tasks without airflow owners:
 
-.. literalinclude:: /../tests/cluster_policies/__init__.py
+.. literalinclude:: /../../tests/cluster_policies/__init__.py
       :language: python
       :start-after: [START example_cluster_policy_rule]
       :end-before: [END example_cluster_policy_rule]
@@ -1276,7 +1276,7 @@ the UI (and import errors table in the database).
 
 For Example in ``airflow_local_settings.py``:
 
-.. literalinclude:: /../tests/cluster_policies/__init__.py
+.. literalinclude:: /../../tests/cluster_policies/__init__.py
       :language: python
       :start-after: [START example_list_of_cluster_policy_rules]
       :end-before: [END example_list_of_cluster_policy_rules]
@@ -1286,7 +1286,7 @@ Task instance mutation hook
 Task instance mutation hook can be used for example to re-routes the task to
 execute in a different queue during retries:
 
-.. literalinclude:: /../tests/cluster_policies/__init__.py
+.. literalinclude:: /../../tests/cluster_policies/__init__.py
       :language: python
       :start-after: [START example_task_mutation_hook]
       :end-before: [END example_task_mutation_hook]

diff --git a/docs/configurations-ref.rst → docs/apache-airflow/configurations-ref.rst b/docs/configurations-ref.rst → docs/apache-airflow/configurations-ref.rst
diff --git a/docs/dag-run.rst → docs/apache-airflow/dag-run.rst b/docs/dag-run.rst → docs/apache-airflow/dag-run.rst
diff --git a/docs/dag-serialization.rst → docs/apache-airflow/dag-serialization.rst b/docs/dag-serialization.rst → docs/apache-airflow/dag-serialization.rst
diff --git a/docs/executor/celery.rst → docs/apache-airflow/executor/celery.rst b/docs/executor/celery.rst → docs/apache-airflow/executor/celery.rst
diff --git a/docs/executor/celery_kubernetes.rst → ...he-airflow/executor/celery_kubernetes.rst b/docs/executor/celery_kubernetes.rst → ...he-airflow/executor/celery_kubernetes.rst
diff --git a/docs/executor/dask.rst → docs/apache-airflow/executor/dask.rst b/docs/executor/dask.rst → docs/apache-airflow/executor/dask.rst
diff --git a/docs/executor/debug.rst → docs/apache-airflow/executor/debug.rst b/docs/executor/debug.rst → docs/apache-airflow/executor/debug.rst
diff --git a/docs/executor/index.rst → docs/apache-airflow/executor/index.rst b/docs/executor/index.rst → docs/apache-airflow/executor/index.rst
diff --git a/docs/executor/kubernetes.rst → docs/apache-airflow/executor/kubernetes.rst b/docs/executor/kubernetes.rst → docs/apache-airflow/executor/kubernetes.rst
@@ -77,21 +77,21 @@ With these requirements in mind, here are some examples of basic ``pod_template_
 
 pod_template_file using the ``dag_in_image`` setting:
 
-.. exampleinclude:: /../airflow/kubernetes/pod_template_file_examples/dags_in_image_template.yaml
+.. exampleinclude:: /../../airflow/kubernetes/pod_template_file_examples/dags_in_image_template.yaml
     :language: yaml
     :start-after: [START template_with_dags_in_image]
     :end-before: [END template_with_dags_in_image]
 
 ``pod_template_file`` which stores DAGs in a ``persistentVolume``:
 
-.. exampleinclude:: /../airflow/kubernetes/pod_template_file_examples/dags_in_volume_template.yaml
+.. exampleinclude:: /../../airflow/kubernetes/pod_template_file_examples/dags_in_volume_template.yaml
     :language: yaml
     :start-after: [START template_with_dags_in_volume]
     :end-before: [END template_with_dags_in_volume]
 
 ``pod_template_file`` which pulls DAGs from git:
 
-.. exampleinclude:: /../airflow/kubernetes/pod_template_file_examples/git_sync_template.yaml
+.. exampleinclude:: /../../airflow/kubernetes/pod_template_file_examples/git_sync_template.yaml
     :language: yaml
     :start-after:  [START git_sync_template]
     :end-before: [END git_sync_template]
@@ -108,7 +108,7 @@ Please note that the scheduler will override the ``metadata.name`` of the V1pod
 To overwrite the base container of the pod launched by the KubernetesExecutor,
 create a V1pod with a single container, and overwrite the fields as follows:
 
-.. exampleinclude:: /../airflow/example_dags/example_kubernetes_executor_config.py
+.. exampleinclude:: /../../airflow/example_dags/example_kubernetes_executor_config.py
     :language: python
     :start-after: [START task_with_volume]
     :end-before: [END task_with_volume]
@@ -118,7 +118,7 @@ Note that volume mounts environment variables, ports, and devices will all be ex
 To add a sidecar container to the launched pod, create a V1pod with an empty first container with the
 name ``base`` and a second container containing your desired sidecar.
 
-.. exampleinclude:: /../airflow/example_dags/example_kubernetes_executor_config.py
+.. exampleinclude:: /../../airflow/example_dags/example_kubernetes_executor_config.py
     :language: python
     :start-after: [START task_with_sidecar]
     :end-before: [END task_with_sidecar]
@@ -128,7 +128,7 @@ This will replace the default ``pod_template_file`` named in the airflow.cfg and
 
 Here is an example of a task with both features:
 
-.. exampleinclude:: /../airflow/example_dags/example_kubernetes_executor_config.py
+.. exampleinclude:: /../../airflow/example_dags/example_kubernetes_executor_config.py
     :language: python
     :start-after: [START task_with_template]
     :end-before: [END task_with_template]

diff --git a/docs/executor/local.rst → docs/apache-airflow/executor/local.rst b/docs/executor/local.rst → docs/apache-airflow/executor/local.rst
diff --git a/docs/executor/sequential.rst → docs/apache-airflow/executor/sequential.rst b/docs/executor/sequential.rst → docs/apache-airflow/executor/sequential.rst
diff --git a/docs/extra-packages-ref.rst → docs/apache-airflow/extra-packages-ref.rst b/docs/extra-packages-ref.rst → docs/apache-airflow/extra-packages-ref.rst
diff --git a/docs/faq.rst → docs/apache-airflow/faq.rst b/docs/faq.rst → docs/apache-airflow/faq.rst
diff --git a/docs/howto/add-dag-tags.rst → docs/apache-airflow/howto/add-dag-tags.rst b/docs/howto/add-dag-tags.rst → docs/apache-airflow/howto/add-dag-tags.rst
diff --git a/docs/howto/connection.rst → docs/apache-airflow/howto/connection.rst b/docs/howto/connection.rst → docs/apache-airflow/howto/connection.rst
diff --git a/docs/howto/custom-operator.rst → .../apache-airflow/howto/custom-operator.rst b/docs/howto/custom-operator.rst → .../apache-airflow/howto/custom-operator.rst
diff --git a/docs/howto/customize-state-colors-ui.rst → ...rflow/howto/customize-state-colors-ui.rst b/docs/howto/customize-state-colors-ui.rst → ...rflow/howto/customize-state-colors-ui.rst
diff --git a/docs/howto/define_extra_link.rst → ...pache-airflow/howto/define_extra_link.rst b/docs/howto/define_extra_link.rst → ...pache-airflow/howto/define_extra_link.rst
diff --git a/docs/howto/email-config.rst → docs/apache-airflow/howto/email-config.rst b/docs/howto/email-config.rst → docs/apache-airflow/howto/email-config.rst
diff --git a/docs/howto/index.rst → docs/apache-airflow/howto/index.rst b/docs/howto/index.rst → docs/apache-airflow/howto/index.rst
diff --git a/docs/howto/initialize-database.rst → ...che-airflow/howto/initialize-database.rst b/docs/howto/initialize-database.rst → ...che-airflow/howto/initialize-database.rst
diff --git a/docs/howto/operator/bash.rst → docs/apache-airflow/howto/operator/bash.rst b/docs/howto/operator/bash.rst → docs/apache-airflow/howto/operator/bash.rst
@@ -25,7 +25,7 @@ BashOperator
 Use the :class:`~airflow.operators.bash.BashOperator` to execute
 commands in a `Bash <https://www.gnu.org/software/bash/>`__ shell.
 
-.. exampleinclude:: /../airflow/example_dags/example_bash_operator.py
+.. exampleinclude:: /../../airflow/example_dags/example_bash_operator.py
     :language: python
     :start-after: [START howto_operator_bash]
     :end-before: [END howto_operator_bash]
@@ -36,7 +36,7 @@ Templating
 You can use :ref:`Jinja templates <jinja-templating>` to parameterize the
 ``bash_command`` argument.
 
-.. exampleinclude:: /../airflow/example_dags/example_bash_operator.py
+.. exampleinclude:: /../../airflow/example_dags/example_bash_operator.py
     :language: python
     :start-after: [START howto_operator_bash_template]
     :end-before: [END howto_operator_bash_template]

diff --git a/docs/howto/operator/external_task_sensor.rst → ...w/howto/operator/external_task_sensor.rst b/docs/howto/operator/external_task_sensor.rst → ...w/howto/operator/external_task_sensor.rst
@@ -44,7 +44,7 @@ wait for another task on a different DAG for a specific ``execution_date``.
 ExternalTaskSensor also provide options to set if the Task on a remote DAG succeeded or failed
 via ``allowed_states`` and ``failed_states`` parameters.
 
-.. exampleinclude:: /../airflow/example_dags/example_external_task_marker_dag.py
+.. exampleinclude:: /../../airflow/example_dags/example_external_task_marker_dag.py
     :language: python
     :start-after: [START howto_operator_external_task_sensor]
     :end-before: [END howto_operator_external_task_sensor]
@@ -58,7 +58,7 @@ on ``child_dag`` for a specific ``execution_date`` should also be cleared, ``Ext
 should be used. Note that ``child_task1`` will only be cleared if "Recursive" is selected when the
 user clears ``parent_task``.
 
-.. exampleinclude:: /../airflow/example_dags/example_external_task_marker_dag.py
+.. exampleinclude:: /../../airflow/example_dags/example_external_task_marker_dag.py
     :language: python
     :start-after: [START howto_operator_external_task_marker]
     :end-before: [END howto_operator_external_task_marker]
diff --git a/docs/howto/operator/index.rst → docs/apache-airflow/howto/operator/index.rst b/docs/howto/operator/index.rst → docs/apache-airflow/howto/operator/index.rst
@@ -25,7 +25,7 @@ determine what actually executes when your DAG runs.
 
 .. note::
     See the :ref:`Operators Concepts <concepts:operators>` documentation and the
-    :doc:`Operators API Reference <../../_api/index>` for more
+    :doc:`Operators API Reference </python-api-ref>` for more
     information.
 
 .. toctree::

diff --git a/docs/howto/operator/python.rst → .../apache-airflow/howto/operator/python.rst b/docs/howto/operator/python.rst → .../apache-airflow/howto/operator/python.rst
@@ -25,7 +25,7 @@ PythonOperator
 Use the :class:`~airflow.operators.python.PythonOperator` to execute
 Python callables.
 
-.. exampleinclude:: /../airflow/example_dags/example_python_operator.py
+.. exampleinclude:: /../../airflow/example_dags/example_python_operator.py
     :language: python
     :start-after: [START howto_operator_python]
     :end-before: [END howto_operator_python]
@@ -36,7 +36,7 @@ Passing in arguments
 Use the ``op_args`` and ``op_kwargs`` arguments to pass additional arguments
 to the Python callable.
 
-.. exampleinclude:: /../airflow/example_dags/example_python_operator.py
+.. exampleinclude:: /../../airflow/example_dags/example_python_operator.py
     :language: python
     :start-after: [START howto_operator_python_kwargs]
     :end-before: [END howto_operator_python_kwargs]
@@ -61,7 +61,7 @@ PythonVirtualenvOperator
 Use the :class:`~airflow.operators.python.PythonVirtualenvOperator` to execute
 Python callables inside a new Python virtual environment.
 
-.. exampleinclude:: ../../../airflow/example_dags/example_python_operator.py
+.. exampleinclude:: /../../airflow/example_dags/example_python_operator.py
     :language: python
     :start-after: [START howto_operator_python_venv]
     :end-before: [END howto_operator_python_venv]

diff --git a/docs/howto/run-behind-proxy.rst → ...apache-airflow/howto/run-behind-proxy.rst b/docs/howto/run-behind-proxy.rst → ...apache-airflow/howto/run-behind-proxy.rst
diff --git a/docs/howto/run-with-systemd.rst → ...apache-airflow/howto/run-with-systemd.rst b/docs/howto/run-with-systemd.rst → ...apache-airflow/howto/run-with-systemd.rst
diff --git a/docs/howto/run-with-upstart.rst → ...apache-airflow/howto/run-with-upstart.rst b/docs/howto/run-with-upstart.rst → ...apache-airflow/howto/run-with-upstart.rst
diff --git a/docs/howto/set-config.rst → docs/apache-airflow/howto/set-config.rst b/docs/howto/set-config.rst → docs/apache-airflow/howto/set-config.rst
diff --git a/docs/howto/use-test-config.rst → .../apache-airflow/howto/use-test-config.rst b/docs/howto/use-test-config.rst → .../apache-airflow/howto/use-test-config.rst
diff --git a/docs/howto/variable.rst → docs/apache-airflow/howto/variable.rst b/docs/howto/variable.rst → docs/apache-airflow/howto/variable.rst
diff --git a/docs/img/add-dag-tags.png → docs/apache-airflow/img/add-dag-tags.png b/docs/img/add-dag-tags.png → docs/apache-airflow/img/add-dag-tags.png
diff --git a/docs/img/add-role.png → docs/apache-airflow/img/add-role.png b/docs/img/add-role.png → docs/apache-airflow/img/add-role.png
diff --git a/docs/img/airflow.gif → docs/apache-airflow/img/airflow.gif b/docs/img/airflow.gif → docs/apache-airflow/img/airflow.gif
diff --git a/docs/img/apache.jpg → docs/apache-airflow/img/apache.jpg b/docs/img/apache.jpg → docs/apache-airflow/img/apache.jpg
diff --git a/docs/img/arch-diag-basic.png → docs/apache-airflow/img/arch-diag-basic.png b/docs/img/arch-diag-basic.png → docs/apache-airflow/img/arch-diag-basic.png
diff --git a/docs/img/arch-diag-kubernetes.png → ...ache-airflow/img/arch-diag-kubernetes.png b/docs/img/arch-diag-kubernetes.png → ...ache-airflow/img/arch-diag-kubernetes.png
diff --git a/docs/img/arch-diag-kubernetes2.png → ...che-airflow/img/arch-diag-kubernetes2.png b/docs/img/arch-diag-kubernetes2.png → ...che-airflow/img/arch-diag-kubernetes2.png
diff --git a/docs/img/arch-diag-logging.png → .../apache-airflow/img/arch-diag-logging.png b/docs/img/arch-diag-logging.png → .../apache-airflow/img/arch-diag-logging.png
diff --git a/docs/img/aws-web-identity-federation-gcp.png → ...w/img/aws-web-identity-federation-gcp.png b/docs/img/aws-web-identity-federation-gcp.png → ...w/img/aws-web-identity-federation-gcp.png
diff --git a/docs/img/branch_note.png → docs/apache-airflow/img/branch_note.png b/docs/img/branch_note.png → docs/apache-airflow/img/branch_note.png
diff --git a/docs/img/branch_with_trigger.png → ...pache-airflow/img/branch_with_trigger.png b/docs/img/branch_with_trigger.png → ...pache-airflow/img/branch_with_trigger.png
diff --git a/docs/img/branch_without_trigger.png → ...he-airflow/img/branch_without_trigger.png b/docs/img/branch_without_trigger.png → ...he-airflow/img/branch_without_trigger.png
diff --git a/docs/img/change-ui-colors/dags-page-new.png → ...ow/img/change-ui-colors/dags-page-new.png b/docs/img/change-ui-colors/dags-page-new.png → ...ow/img/change-ui-colors/dags-page-new.png
diff --git a/docs/img/change-ui-colors/dags-page-old.png → ...ow/img/change-ui-colors/dags-page-old.png b/docs/img/change-ui-colors/dags-page-old.png → ...ow/img/change-ui-colors/dags-page-old.png
diff --git a/docs/img/change-ui-colors/graph-view-new.png → ...w/img/change-ui-colors/graph-view-new.png b/docs/img/change-ui-colors/graph-view-new.png → ...w/img/change-ui-colors/graph-view-new.png
diff --git a/docs/img/change-ui-colors/graph-view-old.png → ...w/img/change-ui-colors/graph-view-old.png b/docs/img/change-ui-colors/graph-view-old.png → ...w/img/change-ui-colors/graph-view-old.png
diff --git a/docs/img/change-ui-colors/tree-view-new.png → ...ow/img/change-ui-colors/tree-view-new.png b/docs/img/change-ui-colors/tree-view-new.png → ...ow/img/change-ui-colors/tree-view-new.png
diff --git a/docs/img/change-ui-colors/tree-view-old.png → ...ow/img/change-ui-colors/tree-view-old.png b/docs/img/change-ui-colors/tree-view-old.png → ...ow/img/change-ui-colors/tree-view-old.png
diff --git a/docs/img/cli_completion.gif → docs/apache-airflow/img/cli_completion.gif b/docs/img/cli_completion.gif → docs/apache-airflow/img/cli_completion.gif
diff --git a/docs/img/code.png → docs/apache-airflow/img/code.png b/docs/img/code.png → docs/apache-airflow/img/code.png
diff --git a/docs/img/connection_create.png → .../apache-airflow/img/connection_create.png b/docs/img/connection_create.png → .../apache-airflow/img/connection_create.png
diff --git a/docs/img/connection_edit.png → docs/apache-airflow/img/connection_edit.png b/docs/img/connection_edit.png → docs/apache-airflow/img/connection_edit.png
diff --git a/docs/img/connections.png → docs/apache-airflow/img/connections.png b/docs/img/connections.png → docs/apache-airflow/img/connections.png
diff --git a/docs/img/context.png → docs/apache-airflow/img/context.png b/docs/img/context.png → docs/apache-airflow/img/context.png
diff --git a/docs/img/dag_serialization.png → .../apache-airflow/img/dag_serialization.png b/docs/img/dag_serialization.png → .../apache-airflow/img/dag_serialization.png
diff --git a/docs/img/dags.png → docs/apache-airflow/img/dags.png b/docs/img/dags.png → docs/apache-airflow/img/dags.png
diff --git a/docs/img/duration.png → docs/apache-airflow/img/duration.png b/docs/img/duration.png → docs/apache-airflow/img/duration.png
diff --git a/docs/img/example_passing_conf.png → ...ache-airflow/img/example_passing_conf.png b/docs/img/example_passing_conf.png → ...ache-airflow/img/example_passing_conf.png
diff --git a/docs/img/gantt.png → docs/apache-airflow/img/gantt.png b/docs/img/gantt.png → docs/apache-airflow/img/gantt.png
diff --git a/docs/img/graph.png → docs/apache-airflow/img/graph.png b/docs/img/graph.png → docs/apache-airflow/img/graph.png
diff --git a/docs/img/k8s-0-worker.jpeg → docs/apache-airflow/img/k8s-0-worker.jpeg b/docs/img/k8s-0-worker.jpeg → docs/apache-airflow/img/k8s-0-worker.jpeg
diff --git a/docs/img/k8s-3-worker.jpeg → docs/apache-airflow/img/k8s-3-worker.jpeg b/docs/img/k8s-3-worker.jpeg → docs/apache-airflow/img/k8s-3-worker.jpeg
diff --git a/docs/img/k8s-5-worker.jpeg → docs/apache-airflow/img/k8s-5-worker.jpeg b/docs/img/k8s-5-worker.jpeg → docs/apache-airflow/img/k8s-5-worker.jpeg
diff --git a/docs/img/k8s-failed-pod.png → docs/apache-airflow/img/k8s-failed-pod.png b/docs/img/k8s-failed-pod.png → docs/apache-airflow/img/k8s-failed-pod.png
diff --git a/docs/img/k8s-happy-path.png → docs/apache-airflow/img/k8s-happy-path.png b/docs/img/k8s-happy-path.png → docs/apache-airflow/img/k8s-happy-path.png
diff --git a/docs/img/latest_only_with_trigger.png → ...-airflow/img/latest_only_with_trigger.png b/docs/img/latest_only_with_trigger.png → ...-airflow/img/latest_only_with_trigger.png
diff --git a/...logos/airflow_64x64_emoji_transparent.png → ...logos/airflow_64x64_emoji_transparent.png b/...logos/airflow_64x64_emoji_transparent.png → ...logos/airflow_64x64_emoji_transparent.png
diff --git a/docs/img/logos/airflow_dark_bg.png → ...che-airflow/img/logos/airflow_dark_bg.png b/docs/img/logos/airflow_dark_bg.png → ...che-airflow/img/logos/airflow_dark_bg.png
diff --git a/docs/img/logos/airflow_transparent.png → ...airflow/img/logos/airflow_transparent.png b/docs/img/logos/airflow_transparent.png → ...airflow/img/logos/airflow_transparent.png
diff --git a/docs/img/logos/airflow_white_bg.png → ...he-airflow/img/logos/airflow_white_bg.png b/docs/img/logos/airflow_white_bg.png → ...he-airflow/img/logos/airflow_white_bg.png
diff --git a/docs/img/logos/wordmark_1.png → docs/apache-airflow/img/logos/wordmark_1.png b/docs/img/logos/wordmark_1.png → docs/apache-airflow/img/logos/wordmark_1.png
diff --git a/docs/img/logos/wordmark_1.svg → docs/apache-airflow/img/logos/wordmark_1.svg b/docs/img/logos/wordmark_1.svg → docs/apache-airflow/img/logos/wordmark_1.svg
diff --git a/docs/img/logos/wordmark_2.png → docs/apache-airflow/img/logos/wordmark_2.png b/docs/img/logos/wordmark_2.png → docs/apache-airflow/img/logos/wordmark_2.png
diff --git a/docs/img/logos/wordmark_2.svg → docs/apache-airflow/img/logos/wordmark_2.svg b/docs/img/logos/wordmark_2.svg → docs/apache-airflow/img/logos/wordmark_2.svg
diff --git a/docs/img/nested_branching.png → docs/apache-airflow/img/nested_branching.png b/docs/img/nested_branching.png → docs/apache-airflow/img/nested_branching.png
diff --git a/docs/img/new-role.png → docs/apache-airflow/img/new-role.png b/docs/img/new-role.png → docs/apache-airflow/img/new-role.png
diff --git a/docs/img/operator_extra_link.png → ...pache-airflow/img/operator_extra_link.png b/docs/img/operator_extra_link.png → ...pache-airflow/img/operator_extra_link.png
diff --git a/docs/img/run_task_on_celery_executor.png → ...rflow/img/run_task_on_celery_executor.png b/docs/img/run_task_on_celery_executor.png → ...rflow/img/run_task_on_celery_executor.png
diff --git a/docs/img/run_task_on_celery_executor.puml → ...flow/img/run_task_on_celery_executor.puml b/docs/img/run_task_on_celery_executor.puml → ...flow/img/run_task_on_celery_executor.puml
diff --git a/docs/img/scheduler_loop.jpg → docs/apache-airflow/img/scheduler_loop.jpg b/docs/img/scheduler_loop.jpg → docs/apache-airflow/img/scheduler_loop.jpg
diff --git a/docs/img/smart_sensor_architecture.png → ...airflow/img/smart_sensor_architecture.png b/docs/img/smart_sensor_architecture.png → ...airflow/img/smart_sensor_architecture.png
diff --git a/...smart_sensor_single_task_execute_flow.png → ...smart_sensor_single_task_execute_flow.png b/...smart_sensor_single_task_execute_flow.png → ...smart_sensor_single_task_execute_flow.png
diff --git a/docs/img/subdag_after.png → docs/apache-airflow/img/subdag_after.png b/docs/img/subdag_after.png → docs/apache-airflow/img/subdag_after.png
diff --git a/docs/img/subdag_before.png → docs/apache-airflow/img/subdag_before.png b/docs/img/subdag_before.png → docs/apache-airflow/img/subdag_before.png
diff --git a/docs/img/subdag_zoom.png → docs/apache-airflow/img/subdag_zoom.png b/docs/img/subdag_zoom.png → docs/apache-airflow/img/subdag_zoom.png
diff --git a/docs/img/task_group.gif → docs/apache-airflow/img/task_group.gif b/docs/img/task_group.gif → docs/apache-airflow/img/task_group.gif
diff --git a/docs/img/task_lifecycle_diagram.png → ...he-airflow/img/task_lifecycle_diagram.png b/docs/img/task_lifecycle_diagram.png → ...he-airflow/img/task_lifecycle_diagram.png
diff --git a/docs/img/task_manual_vs_scheduled.png → ...-airflow/img/task_manual_vs_scheduled.png b/docs/img/task_manual_vs_scheduled.png → ...-airflow/img/task_manual_vs_scheduled.png
diff --git a/docs/img/task_stages.png → docs/apache-airflow/img/task_stages.png b/docs/img/task_stages.png → docs/apache-airflow/img/task_stages.png
diff --git a/docs/img/tree.png → docs/apache-airflow/img/tree.png b/docs/img/tree.png → docs/apache-airflow/img/tree.png
diff --git a/docs/img/ui-timezone-chooser.png → ...pache-airflow/img/ui-timezone-chooser.png b/docs/img/ui-timezone-chooser.png → ...pache-airflow/img/ui-timezone-chooser.png
diff --git a/docs/img/usage_cli_export.png → docs/apache-airflow/img/usage_cli_export.png b/docs/img/usage_cli_export.png → docs/apache-airflow/img/usage_cli_export.png
diff --git a/docs/img/usage_cli_imgcat.png → docs/apache-airflow/img/usage_cli_imgcat.png b/docs/img/usage_cli_imgcat.png → docs/apache-airflow/img/usage_cli_imgcat.png
diff --git a/docs/img/variable_hidden.png → docs/apache-airflow/img/variable_hidden.png b/docs/img/variable_hidden.png → docs/apache-airflow/img/variable_hidden.png
diff --git a/docs/index.rst → docs/apache-airflow/index.rst b/docs/index.rst → docs/apache-airflow/index.rst
@@ -18,7 +18,7 @@
 
 
 
-.. image:: ../airflow/www/static/pin_large.png
+.. image:: ../../airflow/www/static/pin_large.png
     :width: 100
 
 Apache Airflow Documentation
@@ -112,7 +112,7 @@ Content
     Operators and hooks <operators-and-hooks-ref>
     CLI <cli-and-env-variables-ref>
     Macros <macros-ref>
-    Python API <_api/index>
+    Python API <python-api-ref>
     Experimental REST API <rest-api-ref>
     Stable REST API <stable-rest-api-ref>
     Configurations <configurations-ref>

diff --git a/docs/installation.rst → docs/apache-airflow/installation.rst b/docs/installation.rst → docs/apache-airflow/installation.rst
diff --git a/docs/integration.rst → docs/apache-airflow/integration.rst b/docs/integration.rst → docs/apache-airflow/integration.rst
diff --git a/docs/kubernetes.rst → docs/apache-airflow/kubernetes.rst b/docs/kubernetes.rst → docs/apache-airflow/kubernetes.rst
diff --git a/docs/license.rst → docs/apache-airflow/license.rst b/docs/license.rst → docs/apache-airflow/license.rst
diff --git a/docs/lineage.rst → docs/apache-airflow/lineage.rst b/docs/lineage.rst → docs/apache-airflow/lineage.rst
diff --git a/docs/logging-monitoring/check-health.rst → ...rflow/logging-monitoring/check-health.rst b/docs/logging-monitoring/check-health.rst → ...rflow/logging-monitoring/check-health.rst
diff --git a/docs/logging-monitoring/errors.rst → ...che-airflow/logging-monitoring/errors.rst b/docs/logging-monitoring/errors.rst → ...che-airflow/logging-monitoring/errors.rst
diff --git a/docs/logging-monitoring/index.rst → ...ache-airflow/logging-monitoring/index.rst b/docs/logging-monitoring/index.rst → ...ache-airflow/logging-monitoring/index.rst
diff --git a/...gging-monitoring/logging-architecture.rst → ...gging-monitoring/logging-architecture.rst b/...gging-monitoring/logging-architecture.rst → ...gging-monitoring/logging-architecture.rst
diff --git a/docs/logging-monitoring/logging-tasks.rst → ...flow/logging-monitoring/logging-tasks.rst b/docs/logging-monitoring/logging-tasks.rst → ...flow/logging-monitoring/logging-tasks.rst
diff --git a/docs/logging-monitoring/metrics.rst → ...he-airflow/logging-monitoring/metrics.rst b/docs/logging-monitoring/metrics.rst → ...he-airflow/logging-monitoring/metrics.rst
diff --git a/...ing-monitoring/tracking-user-activity.rst → ...ing-monitoring/tracking-user-activity.rst b/...ing-monitoring/tracking-user-activity.rst → ...ing-monitoring/tracking-user-activity.rst
diff --git a/docs/macros-ref.rst → docs/apache-airflow/macros-ref.rst b/docs/macros-ref.rst → docs/apache-airflow/macros-ref.rst
diff --git a/docs/modules_management.rst → docs/apache-airflow/modules_management.rst b/docs/modules_management.rst → docs/apache-airflow/modules_management.rst
diff --git a/docs/operators-and-hooks-ref.rst → ...pache-airflow/operators-and-hooks-ref.rst b/docs/operators-and-hooks-ref.rst → ...pache-airflow/operators-and-hooks-ref.rst
diff --git a/docs/plugins.rst → docs/apache-airflow/plugins.rst b/docs/plugins.rst → docs/apache-airflow/plugins.rst
diff --git a/docs/privacy_notice.rst → docs/apache-airflow/privacy_notice.rst b/docs/privacy_notice.rst → docs/apache-airflow/privacy_notice.rst
diff --git a/docs/production-deployment.rst → .../apache-airflow/production-deployment.rst b/docs/production-deployment.rst → .../apache-airflow/production-deployment.rst
diff --git a/docs/project.rst → docs/apache-airflow/project.rst b/docs/project.rst → docs/apache-airflow/project.rst
diff --git a/docs/autoapi_templates/index.rst → docs/apache-airflow/python-api-ref.rst b/docs/autoapi_templates/index.rst → docs/apache-airflow/python-api-ref.rst
@@ -62,9 +62,9 @@ All operators are in the following packages:
   :glob:
   :maxdepth: 1
 
-  airflow/operators/index
+  _api/airflow/operators/index
 
-  airflow/sensors/index
+  _api/airflow/sensors/index
 
 
 .. _pythonapi:hooks:
@@ -84,7 +84,7 @@ All hooks are in the following packages:
   :glob:
   :maxdepth: 1
 
-  airflow/hooks/index
+  _api/airflow/hooks/index
 
 Executors
 ---------
@@ -100,7 +100,7 @@ All executors are in the following packages:
   :glob:
   :maxdepth: 1
 
-  airflow/executors/index
+  _api/airflow/executors/index
 
 Models
 ------
@@ -112,7 +112,7 @@ persisted in the database.
   :glob:
   :maxdepth: 1
 
-  airflow/models/index
+  _api/airflow/models/index
 
 .. _pythonapi:exceptions:
 
@@ -124,7 +124,7 @@ Exceptions
   :glob:
   :maxdepth: 1
 
-  airflow/exceptions/index
+  _api/airflow/exceptions/index
 
 Secrets Backends
 ----------------
@@ -136,4 +136,4 @@ All secrets backends derive from :class:`~airflow.secrets.BaseSecretsBackend`.
   :glob:
   :maxdepth: 1
 
-  airflow/secrets/index
+  _api/airflow/secrets/index
diff --git a/docs/redirects.txt → docs/apache-airflow/redirects.txt b/docs/redirects.txt → docs/apache-airflow/redirects.txt
@@ -85,3 +85,4 @@ errors.rst logging-monitoring/errors.rst
 howto/write-logs.rst logging-monitoring/logging-tasks.rst
 metrics.rst logging-monitoring/metrics.rst
 howto/tracking-user-activity.rst logging-monitoring/tracking-user-activity.rst
+_api/index.rst python-api-ref.rst
diff --git a/docs/rest-api-ref.rst → docs/apache-airflow/rest-api-ref.rst b/docs/rest-api-ref.rst → docs/apache-airflow/rest-api-ref.rst
diff --git a/docs/scheduler.rst → docs/apache-airflow/scheduler.rst b/docs/scheduler.rst → docs/apache-airflow/scheduler.rst
diff --git a/docs/security/access-control.rst → ...pache-airflow/security/access-control.rst b/docs/security/access-control.rst → ...pache-airflow/security/access-control.rst
@@ -55,7 +55,7 @@ Viewer
 ^^^^^^
 ``Viewer`` users have limited viewer permissions
 
-.. exampleinclude:: /../airflow/www/security.py
+.. exampleinclude:: /../../airflow/www/security.py
     :language: python
     :start-after: [START security_viewer_perms]
     :end-before: [END security_viewer_perms]
@@ -66,7 +66,7 @@ User
 ^^^^
 ``User`` users have ``Viewer`` permissions plus additional user permissions
 
-.. exampleinclude:: /../airflow/www/security.py
+.. exampleinclude:: /../../airflow/www/security.py
     :language: python
     :start-after: [START security_user_perms]
     :end-before: [END security_user_perms]
@@ -77,7 +77,7 @@ Op
 ^^
 ``Op`` users have ``User`` permissions plus additional op permissions
 
-.. exampleinclude:: /../airflow/www/security.py
+.. exampleinclude:: /../../airflow/www/security.py
     :language: python
     :start-after: [START security_op_perms]
     :end-before: [END security_op_perms]

diff --git a/docs/security/api.rst → docs/apache-airflow/security/api.rst b/docs/security/api.rst → docs/apache-airflow/security/api.rst
diff --git a/docs/security/flower.rst → docs/apache-airflow/security/flower.rst b/docs/security/flower.rst → docs/apache-airflow/security/flower.rst
diff --git a/docs/security/index.rst → docs/apache-airflow/security/index.rst b/docs/security/index.rst → docs/apache-airflow/security/index.rst
@@ -27,4 +27,4 @@ Security
     *
     secrets/index
 
-.. include:: /../.github/SECURITY.rst
+.. include:: /../../.github/SECURITY.rst
diff --git a/docs/security/kerberos.rst → docs/apache-airflow/security/kerberos.rst b/docs/security/kerberos.rst → docs/apache-airflow/security/kerberos.rst
diff --git a/docs/security/secrets/fernet.rst → ...pache-airflow/security/secrets/fernet.rst b/docs/security/secrets/fernet.rst → ...pache-airflow/security/secrets/fernet.rst
diff --git a/docs/security/secrets/index.rst → ...apache-airflow/security/secrets/index.rst b/docs/security/secrets/index.rst → ...apache-airflow/security/secrets/index.rst
diff --git a/...-backend/aws-secrets-manaager-backend.rst → ...-backend/aws-secrets-manaager-backend.rst b/...-backend/aws-secrets-manaager-backend.rst → ...-backend/aws-secrets-manaager-backend.rst
diff --git a/...s-ssm-parameter-store-secrets-backend.rst → ...s-ssm-parameter-store-secrets-backend.rst b/...s-ssm-parameter-store-secrets-backend.rst → ...s-ssm-parameter-store-secrets-backend.rst
diff --git a/...ckend/azure-key-vault-secrets-backend.rst → ...ckend/azure-key-vault-secrets-backend.rst b/...ckend/azure-key-vault-secrets-backend.rst → ...ckend/azure-key-vault-secrets-backend.rst
diff --git a/...d/google-cloud-secret-manager-backend.rst → ...d/google-cloud-secret-manager-backend.rst b/...d/google-cloud-secret-manager-backend.rst → ...d/google-cloud-secret-manager-backend.rst
diff --git a/...ckend/hashicorp-vault-secrets-backend.rst → ...ckend/hashicorp-vault-secrets-backend.rst b/...ckend/hashicorp-vault-secrets-backend.rst → ...ckend/hashicorp-vault-secrets-backend.rst
diff --git a/...ecurity/secrets/secrets-backend/index.rst → ...ecurity/secrets/secrets-backend/index.rst b/...ecurity/secrets/secrets-backend/index.rst → ...ecurity/secrets/secrets-backend/index.rst
diff --git a/...kend/local-filesystem-secrets-backend.rst → ...kend/local-filesystem-secrets-backend.rst b/...kend/local-filesystem-secrets-backend.rst → ...kend/local-filesystem-secrets-backend.rst
diff --git a/docs/security/webserver.rst → docs/apache-airflow/security/webserver.rst b/docs/security/webserver.rst → docs/apache-airflow/security/webserver.rst
diff --git a/docs/security/workload.rst → docs/apache-airflow/security/workload.rst b/docs/security/workload.rst → docs/apache-airflow/security/workload.rst
diff --git a/docs/smart-sensor.rst → docs/apache-airflow/smart-sensor.rst b/docs/smart-sensor.rst → docs/apache-airflow/smart-sensor.rst
diff --git a/docs/stable-rest-api-ref.rst → docs/apache-airflow/stable-rest-api-ref.rst b/docs/stable-rest-api-ref.rst → docs/apache-airflow/stable-rest-api-ref.rst
diff --git a/docs/start.rst → docs/apache-airflow/start.rst b/docs/start.rst → docs/apache-airflow/start.rst
diff --git a/docs/static/exampleinclude.css → .../apache-airflow/static/exampleinclude.css b/docs/static/exampleinclude.css → .../apache-airflow/static/exampleinclude.css
diff --git a/docs/static/jira-links.js → docs/apache-airflow/static/jira-links.js b/docs/static/jira-links.js → docs/apache-airflow/static/jira-links.js
diff --git a/docs/templates/footer.html → docs/apache-airflow/templates/footer.html b/docs/templates/footer.html → docs/apache-airflow/templates/footer.html
diff --git a/docs/timezone.rst → docs/apache-airflow/timezone.rst b/docs/timezone.rst → docs/apache-airflow/timezone.rst