You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2018/12/24 19:06:34 UTC
[GitHub] stale[bot] closed pull request #3725: [AIRFLOW-2877] Make docs site
URL consistent everywhere
stale[bot] closed pull request #3725: [AIRFLOW-2877] Make docs site URL consistent everywhere
URL: https://github.com/apache/incubator-airflow/pull/3725
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 060c5dd84d..7c6f45b8b0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -61,8 +61,16 @@ If you are proposing a feature:
## Documentation
-The latest API documentation is usually available
-[here](https://airflow.incubator.apache.org/). To generate a local version,
+The Airflow documentation is located at:
+
+- <https://airflow.apache.org> (points to
+ <https://airflow.readthedocs.io/en/stable/>) (latest stable)
+- <https://airflow.readthedocs.io/en/latest/> (latest master)
+
+The documentation for release versions ≥ 1.9 can be accessed from the above
+links as well (e.g., 1.9.0 is https://airflow.readthedocs.io/en/1.9.0/).
+
+To generate a local version,
you need to have set up an Airflow development environment (see below). Also
install the `doc` extra.
diff --git a/README.md b/README.md
index 0f5c71446c..0cb4a95875 100644
--- a/README.md
+++ b/README.md
@@ -24,9 +24,12 @@ monitor progress, and troubleshoot issues when needed.
## Getting started
-Please visit the Airflow Platform documentation (latest **stable** release) for help with [installing Airflow](https://airflow.incubator.apache.org/installation.html), getting a [quick start](https://airflow.incubator.apache.org/start.html), or a more complete [tutorial](https://airflow.incubator.apache.org/tutorial.html).
+Please visit the Airflow Platform documentation (latest **stable** release) for help with [installing Airflow](https://airflow.apache.org/installation.html), getting a [quick start](https://airflow.apache.org/start.html), or a more complete [tutorial](https://airflow.apache.org/tutorial.html).
-Documentation of GitHub master (latest development branch): [ReadTheDocs Documentation](https://airflow.readthedocs.io/en/latest/)
+Documentation for the latest master branch is available at <https://airflow.readthedocs.io/en/latest/>.
+
+The documentation for release versions ≥ 1.9 can be accessed from the above
+links as well (e.g., 1.9.0 is https://airflow.readthedocs.io/en/1.9.0/).
For further information, please visit the [Airflow Wiki](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Home).
@@ -272,7 +275,7 @@ Currently **officially** using Airflow:
## Who Maintains Airflow?
-Airflow is the work of the
+Airflow is the work of the
[community](https://github.com/apache/incubator-airflow/graphs/contributors),
but the [core committers/maintainers](https://people.apache.org/committers-by-project.html#airflow)
are responsible for reviewing and merging PRs as well as steering conversation around new feature requests.
@@ -281,7 +284,7 @@ If you would like to become a maintainer, please review the Apache Airflow
## Links
-- [Documentation](https://airflow.incubator.apache.org/)
+- [Documentation](https://airflow.apache.org)
- [Chat](https://gitter.im/apache/incubator-airflow)
- [Apache Airflow Incubation Status](http://incubator.apache.org/projects/airflow.html)
- [More](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Links)
diff --git a/UPDATING.md b/UPDATING.md
index 4fda57663f..75ea5b6c13 100644
--- a/UPDATING.md
+++ b/UPDATING.md
@@ -326,7 +326,7 @@ The `file_task_handler` logger has been made more flexible. The default format c
#### I'm using S3Log or GCSLogs, what do I do!?
-If you are logging to Google cloud storage, please see the [Google cloud platform documentation](https://airflow.incubator.apache.org/integration.html#gcp-google-cloud-platform) for logging instructions.
+If you are logging to Google cloud storage, please see the [Google cloud platform documentation](https://airflow.apache.org/integration.html#gcp-google-cloud-platform) for logging instructions.
If you are using S3, the instructions should be largely the same as the Google cloud platform instructions above. You will need a custom logging config. The `REMOTE_BASE_LOG_FOLDER` configuration key in your airflow config has been removed, therefore you will need to take the following steps:
diff --git a/airflow/config_templates/default_airflow.cfg b/airflow/config_templates/default_airflow.cfg
index b957d41355..e007a3a764 100644
--- a/airflow/config_templates/default_airflow.cfg
+++ b/airflow/config_templates/default_airflow.cfg
@@ -269,7 +269,7 @@ error_logfile = -
expose_config = False
# Set to true to turn on authentication:
-# https://airflow.incubator.apache.org/security.html#web-authentication
+# https://airflow.apache.org/security.html#web-authentication
authenticate = False
# Filter the list of dags by owner name (requires authentication to be enabled)
diff --git a/airflow/example_dags/tutorial.py b/airflow/example_dags/tutorial.py
index ad817338ef..f2e20b47ca 100644
--- a/airflow/example_dags/tutorial.py
+++ b/airflow/example_dags/tutorial.py
@@ -20,7 +20,7 @@
"""
### Tutorial Documentation
Documentation that goes along with the Airflow tutorial located
-[here](https://airflow.incubator.apache.org/tutorial.html)
+[here](https://airflow.apache.org/tutorial.html)
"""
import airflow
from airflow import DAG
diff --git a/airflow/www/app.py b/airflow/www/app.py
index 319fe11ada..15e7a593cd 100644
--- a/airflow/www/app.py
+++ b/airflow/www/app.py
@@ -121,7 +121,7 @@ def create_app(config=None, testing=False):
admin.add_link(base.MenuLink(
category='Docs', name='Documentation',
- url='https://airflow.incubator.apache.org/'))
+ url='https://airflow.apache.org'))
admin.add_link(
base.MenuLink(category='Docs',
name='Github',
diff --git a/airflow/www_rbac/app.py b/airflow/www_rbac/app.py
index 8d3400a668..99390bdbc5 100644
--- a/airflow/www_rbac/app.py
+++ b/airflow/www_rbac/app.py
@@ -126,7 +126,7 @@ def init_views(appbuilder):
"XComs",
category="Admin")
appbuilder.add_link("Documentation",
- href='https://airflow.apache.org/',
+ href='https://airflow.apache.org',
category="Docs",
category_icon="fa-cube")
appbuilder.add_link("Github",
diff --git a/docs/plugins.rst b/docs/plugins.rst
index 3f1f7ee804..b4b99b444e 100644
--- a/docs/plugins.rst
+++ b/docs/plugins.rst
@@ -157,7 +157,7 @@ definitions in Airflow.
ml = MenuLink(
category='Test Plugin',
name='Test Menu Link',
- url='https://airflow.incubator.apache.org/')
+ url='https://airflow.apache.org')
# Defining the plugin class
class AirflowTestPlugin(AirflowPlugin):
diff --git a/docs/project.rst b/docs/project.rst
index cd3b60fca1..0330569acd 100644
--- a/docs/project.rst
+++ b/docs/project.rst
@@ -40,7 +40,7 @@ Contributor page:
Resources & links
-----------------
-* `Airflow's official documentation <http://airflow.apache.org/>`_
+* `Airflow's official documentation <https://airflow.apache.org>`_
* Mailing list (send emails to
``dev-subscribe@airflow.incubator.apache.org`` and/or
``commits-subscribe@airflow.incubator.apache.org``
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index 1c2dfd69b7..9d93d9e635 100644
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -278,7 +278,7 @@ something like this:
"""
Code that goes along with the Airflow located at:
- http://airflow.readthedocs.org/en/latest/tutorial.html
+ https://airflow.apache.org/tutorial.html
"""
from airflow import DAG
from airflow.operators.bash_operator import BashOperator
diff --git a/scripts/ci/kubernetes/kube/configmaps.yaml b/scripts/ci/kubernetes/kube/configmaps.yaml
index 3e64ae4e47..c2d5dfa4f2 100644
--- a/scripts/ci/kubernetes/kube/configmaps.yaml
+++ b/scripts/ci/kubernetes/kube/configmaps.yaml
@@ -122,7 +122,7 @@ data:
expose_config = False
# Set to true to turn on authentication:
- # https://airflow.incubator.apache.org/security.html#web-authentication
+ # https://airflow.apache.org/security.html#web-authentication
authenticate = False
# Filter the list of dags by owner name (requires authentication to be enabled)
diff --git a/setup.py b/setup.py
index b92d267aaa..dcd7d8cb39 100644
--- a/setup.py
+++ b/setup.py
@@ -402,7 +402,7 @@ def do_setup():
],
author='Apache Software Foundation',
author_email='dev@airflow.incubator.apache.org',
- url='http://airflow.incubator.apache.org/',
+ url='https://airflow.apache.org',
download_url=(
'https://dist.apache.org/repos/dist/release/incubator/airflow/' + version),
cmdclass={
diff --git a/tests/plugins/test_plugin.py b/tests/plugins/test_plugin.py
index d4c7f27b1c..16697149e2 100644
--- a/tests/plugins/test_plugin.py
+++ b/tests/plugins/test_plugin.py
@@ -7,9 +7,9 @@
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
-#
+#
# http://www.apache.org/licenses/LICENSE-2.0
-#
+#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -70,7 +70,7 @@ def test(self):
ml = MenuLink(
category='Test Plugin',
name='Test Menu Link',
- url='https://airflow.incubator.apache.org/')
+ url='https://airflow.apache.org')
# Defining the plugin class
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services