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 2020/11/22 10:24:55 UTC
[GitHub] [airflow] mik-laj opened a new pull request #12541: Deprecate Read the Docs
mik-laj opened a new pull request #12541:
URL: https://github.com/apache/airflow/pull/12541
We started publishing documentation on S3, so now it's worth encouraging people to use it. So I changed all addresses to S3 and also redirected from RTD to S3.
*All links should still work.*
You can check it by replacing the `airflow` to `apache-airflow-dev` in the address. There is build documentation from `mik-laj/apache` repository `docs-v2` branch.
```
https://airflow.readthedocs.io/en/latest/dag-run.html
https://apache-airflow-dev.readthedocs.io/en/latest/dag-run.html
````
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] github-actions[bot] commented on pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #12541:
URL: https://github.com/apache/airflow/pull/12541#issuecomment-731734272
The PR needs to run all tests because it modifies core of Airflow! Please rebase it to latest master or ask committer to re-run it!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] mik-laj commented on a change in pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #12541:
URL: https://github.com/apache/airflow/pull/12541#discussion_r528323508
##########
File path: README.md
##########
@@ -98,7 +98,7 @@ running multiple schedulers -- please see the "Scheduler" docs.
Visit the official Airflow website documentation (latest **stable** release) for help with [installing Airflow](https://airflow.apache.org/installation.html), [getting started](https://airflow.apache.org/start.html), or walking through a more complete [tutorial](https://airflow.apache.org/tutorial.html).
-> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [ReadTheDocs](https://airflow.readthedocs.io/en/latest/).
+> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [s.apache.org/airflow-docs](https://s.apache.org/airflow-docs/).
Review comment:
I will say more. Only me or INFRA can overwrite this link.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] turbaszek commented on a change in pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
turbaszek commented on a change in pull request #12541:
URL: https://github.com/apache/airflow/pull/12541#discussion_r528322303
##########
File path: README.md
##########
@@ -98,7 +98,7 @@ running multiple schedulers -- please see the "Scheduler" docs.
Visit the official Airflow website documentation (latest **stable** release) for help with [installing Airflow](https://airflow.apache.org/installation.html), [getting started](https://airflow.apache.org/start.html), or walking through a more complete [tutorial](https://airflow.apache.org/tutorial.html).
-> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [ReadTheDocs](https://airflow.readthedocs.io/en/latest/).
+> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [s.apache.org/airflow-docs](https://s.apache.org/airflow-docs/).
Review comment:
The only risk I see is that this s.a.o link can be overridden, right?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] github-actions[bot] commented on pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #12541:
URL: https://github.com/apache/airflow/pull/12541#issuecomment-731729263
[The Workflow run](https://github.com/apache/airflow/actions/runs/377212440) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] potiuk commented on pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
potiuk commented on pull request #12541:
URL: https://github.com/apache/airflow/pull/12541#issuecomment-731828125
Nice!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] mik-laj commented on a change in pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #12541:
URL: https://github.com/apache/airflow/pull/12541#discussion_r528316521
##########
File path: README.md
##########
@@ -98,7 +98,7 @@ running multiple schedulers -- please see the "Scheduler" docs.
Visit the official Airflow website documentation (latest **stable** release) for help with [installing Airflow](https://airflow.apache.org/installation.html), [getting started](https://airflow.apache.org/start.html), or walking through a more complete [tutorial](https://airflow.apache.org/tutorial.html).
-> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [ReadTheDocs](https://airflow.readthedocs.io/en/latest/).
+> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [s.apache.org/airflow-docs](https://s.apache.org/airflow-docs/).
Review comment:
For four reasons:
1. airflow.apache.org is deployed using Git and therefore rolling new versions as regularly as it would be problematic right now. The size of the repository would explode quickly
2. Only committers or Github Action in the same repository can push new commit to airflow-site.
3. This is a development version and we should not publish it on the official website as this could encourage users to install unofficial released versions. Unofficial versions can only be distributed by mailing list and the like.
4. The website is not yet prepared for the new documentation structure. For now, we can only publish documentation for one apache-airflow package. Soon I will be working on updating the theme to support multiple packages.
> **Do not include any links on the project website that might encourage non-developers to download and use nightly builds, snapshots, release candidates, or any other similar package.**
http://www.apache.org/legal/release-policy.html
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] turbaszek commented on a change in pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
turbaszek commented on a change in pull request #12541:
URL: https://github.com/apache/airflow/pull/12541#discussion_r528315324
##########
File path: README.md
##########
@@ -98,7 +98,7 @@ running multiple schedulers -- please see the "Scheduler" docs.
Visit the official Airflow website documentation (latest **stable** release) for help with [installing Airflow](https://airflow.apache.org/installation.html), [getting started](https://airflow.apache.org/start.html), or walking through a more complete [tutorial](https://airflow.apache.org/tutorial.html).
-> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [ReadTheDocs](https://airflow.readthedocs.io/en/latest/).
+> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [s.apache.org/airflow-docs](https://s.apache.org/airflow-docs/).
Review comment:
Probably that was discussed somewhere, but why we cannot have latests docs at `airflow.apache.org`?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] mik-laj merged pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
mik-laj merged pull request #12541:
URL: https://github.com/apache/airflow/pull/12541
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] mik-laj commented on a change in pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #12541:
URL: https://github.com/apache/airflow/pull/12541#discussion_r528316521
##########
File path: README.md
##########
@@ -98,7 +98,7 @@ running multiple schedulers -- please see the "Scheduler" docs.
Visit the official Airflow website documentation (latest **stable** release) for help with [installing Airflow](https://airflow.apache.org/installation.html), [getting started](https://airflow.apache.org/start.html), or walking through a more complete [tutorial](https://airflow.apache.org/tutorial.html).
-> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [ReadTheDocs](https://airflow.readthedocs.io/en/latest/).
+> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [s.apache.org/airflow-docs](https://s.apache.org/airflow-docs/).
Review comment:
For four reasons:
1. airflow.apache.org is deployed using Git and therefore rolling in new versions as regularly as it would be problematic right now. The size of the repository would explode quickly
2. Only committers or Github Action in the same repository can push new commit to airflow-site.
3. This is a development version and we should not publish it on the official website as this could encourage users to install unofficial released versions. Unofficial versions can only be distributed by mailing list and the like.
4. The website is not yet prepared for the new documentation structure. For now, we can only publish documentation for one apache-airflow package. Soon I will be working on updating the theme to support multiple packages.
> **Do not include any links on the project website that might encourage non-developers to download and use nightly builds, snapshots, release candidates, or any other similar package.**
http://www.apache.org/legal/release-policy.html
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
[GitHub] [airflow] turbaszek commented on a change in pull request #12541: Deprecate Read the Docs
Posted by GitBox <gi...@apache.org>.
turbaszek commented on a change in pull request #12541:
URL: https://github.com/apache/airflow/pull/12541#discussion_r528322303
##########
File path: README.md
##########
@@ -98,7 +98,7 @@ running multiple schedulers -- please see the "Scheduler" docs.
Visit the official Airflow website documentation (latest **stable** release) for help with [installing Airflow](https://airflow.apache.org/installation.html), [getting started](https://airflow.apache.org/start.html), or walking through a more complete [tutorial](https://airflow.apache.org/tutorial.html).
-> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [ReadTheDocs](https://airflow.readthedocs.io/en/latest/).
+> Note: If you're looking for documentation for master branch (latest development branch): you can find it on [s.apache.org/airflow-docs](https://s.apache.org/airflow-docs/).
Review comment:
~The only risk I see is that this s.a.o link can be overridden, right?~
Only ASF committers has access so no potential harm
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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