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 2021/01/07 18:49:31 UTC
[GitHub] [airflow] SamWheating opened a new pull request #13547: Fixing broken documentation links in API exceptions
SamWheating opened a new pull request #13547:
URL: https://github.com/apache/airflow/pull/13547
<!--
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/
-->
A user on Slack pointed out that the docs URL returned in a 403 API response was broken. A quick look into the source and it appears that this reference does in fact point to a nonexistent page.
Before:
https://airflow.apache.org/docs/2.0.0/stable-rest-api-ref.html#section/Errors/PermissionDenied
After:
https://airflow.apache.org/docs/apache-airflow/2.0.0/stable-rest-api-ref.html#section/Errors/PermissionDenied
---
**^ 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 #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13547:
URL: https://github.com/apache/airflow/pull/13547#issuecomment-810486120
The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest master or amend the last commit of the PR, and push it with --force-with-lease.
--
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] SamWheating commented on a change in pull request #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
SamWheating commented on a change in pull request #13547:
URL: https://github.com/apache/airflow/pull/13547#discussion_r553517349
##########
File path: airflow/utils/docs.py
##########
@@ -27,7 +27,7 @@ def get_docs_url(page: Optional[str] = None) -> str:
"http://apache-airflow-docs.s3-website.eu-central-1.amazonaws.com/docs/apache-airflow/latest/"
)
else:
- result = f'https://airflow.apache.org/docs/{version.version}/'
+ result = f'https://airflow.apache.org/docs/apache-airflow/{version.version}/'
Review comment:
Maybe its worth updating this function to get URLs for different sections of the documentation for example https://airflow.apache.org/docs/apache-airflow-providers-google?
But also this isn't used in many places.
----------------------------------------------------------------
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] SamWheating commented on pull request #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
SamWheating commented on pull request #13547:
URL: https://github.com/apache/airflow/pull/13547#issuecomment-756310250
I also found this link in the deprecation headers for the experimental API which appears to be broken.
https://github.com/apache/airflow/blob/70290b9e8638412a234fd16283514bfc74ef6908/airflow/www/api/experimental/endpoints.py#L62
However, I don't know what the correct link should be here. Thoughts?
----------------------------------------------------------------
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] SamWheating commented on pull request #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
SamWheating commented on pull request #13547:
URL: https://github.com/apache/airflow/pull/13547#issuecomment-810315490
> @SamWheating if you don't mind rebasing this (and then pinging me), I can get it merged in.
@ryanahamilton done ✅
--
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 pull request #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
mik-laj commented on pull request #13547:
URL: https://github.com/apache/airflow/pull/13547#issuecomment-756360609
> However, I don't know what the correct link should be here. Thoughts?
https://airflow.apache.org/docs/apache-airflow/stable/upgrading-to-2.html#migration-guide-from-experimental-api-to-stable-api-v1
----------------------------------------------------------------
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 #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #13547:
URL: https://github.com/apache/airflow/pull/13547#discussion_r553565489
##########
File path: airflow/utils/docs.py
##########
@@ -27,7 +27,7 @@ def get_docs_url(page: Optional[str] = None) -> str:
"http://apache-airflow-docs.s3-website.eu-central-1.amazonaws.com/docs/apache-airflow/latest/"
)
else:
- result = f'https://airflow.apache.org/docs/{version.version}/'
+ result = f'https://airflow.apache.org/docs/apache-airflow/{version.version}/'
Review comment:
It is not necessary. This feature is only used in Airflow core, so we can only support links to the core.
----------------------------------------------------------------
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] ryanahamilton commented on pull request #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
ryanahamilton commented on pull request #13547:
URL: https://github.com/apache/airflow/pull/13547#issuecomment-809828103
@SamWheating if you don't mind rebasing this (and then pinging me), I can get it merged in.
--
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 #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #13547:
URL: https://github.com/apache/airflow/pull/13547#issuecomment-809824775
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.
--
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] SamWheating edited a comment on pull request #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
SamWheating edited a comment on pull request #13547:
URL: https://github.com/apache/airflow/pull/13547#issuecomment-756310250
I also found this link in the deprecation headers for the experimental API which appears to be broken.
https://github.com/apache/airflow/blob/70290b9e8638412a234fd16283514bfc74ef6908/airflow/www/api/experimental/endpoints.py#L62
However, I don't know what the correct link should be here. Thoughts?
**update:** It looks like its a reference to [this page](https://github.com/ephraimbuddy/airflow/blob/cc089e401df9412c769a2e19fa5879617495f95a/docs/stable-rest-api/migration.rst), which have since been removed.
----------------------------------------------------------------
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] ryanahamilton merged pull request #13547: Fixing broken documentation links in API exceptions
Posted by GitBox <gi...@apache.org>.
ryanahamilton merged pull request #13547:
URL: https://github.com/apache/airflow/pull/13547
--
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