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/11/14 12:15:24 UTC
[GitHub] [airflow] jplauri opened a new issue #19581: Miscellaneous documentation typos
jplauri opened a new issue #19581:
URL: https://github.com/apache/airflow/issues/19581
### Describe the issue with documentation
Recently starting our with Airflow I've been reading parts of the documentations quite carefully. There's at least two typos that could be fixed. First, looking at [Module management](https://airflow.apache.org/docs/apache-airflow/stable/modules_management.html) I see: "You can see the `.ariflowignore` file at the root of your folder." I'm rather confused by this, since when looking at [module_management.rst](https://github.com/apache/airflow/blob/main/docs/apache-airflow/modules_management.rst) it seems to say "You can see the `.airflowignore` file at the root of your folder" (no typo). Why's that?
Second, looking at the docs for [GenericTransfer](https://airflow.apache.org/docs/apache-airflow/stable/_api/airflow/operators/generic_transfer/index.html), the explanation for `destination_conn_id (str)` I believe should be e.g., `destination connection` and not `source connection` (compare with `source_conn_id (str)`). However, I'm unable to find the corresponding doc from the repo. When clicking on "Suggest a change on this page" I end up with 404.
### How to solve the problem
See above for the suggested fixes as well. I'd be happy to submit a PR too (but see some questions above as well).
### Anything else
_No response_
### Are you willing to submit PR?
- [X] Yes I am willing to submit a PR!
### Code of Conduct
- [X] I agree to follow this project's [Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk closed issue #19581: Miscellaneous documentation typos
Posted by GitBox <gi...@apache.org>.
potiuk closed issue #19581:
URL: https://github.com/apache/airflow/issues/19581
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] easontm commented on issue #19581: Miscellaneous documentation typos
Posted by GitBox <gi...@apache.org>.
easontm commented on issue #19581:
URL: https://github.com/apache/airflow/issues/19581#issuecomment-971215557
Ah, the issue is not _in_ the docs themselves, rather the DAG list page which I don't think has that button. I'll make my own PR if I have the time
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on issue #19581: Miscellaneous documentation typos
Posted by GitBox <gi...@apache.org>.
uranusjr commented on issue #19581:
URL: https://github.com/apache/airflow/issues/19581#issuecomment-968281554
Feel free to submit the PR!
The GenericTransfer documentation is automatically generated from Python docstrings with [Sphinx Autodoc](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html). The actual line is in `airflow/operators/generic_transfer.py`.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] easontm commented on issue #19581: Miscellaneous documentation typos
Posted by GitBox <gi...@apache.org>.
easontm commented on issue #19581:
URL: https://github.com/apache/airflow/issues/19581#issuecomment-970265580
Hi @jplauri, could you include this doc change into your PR as well?
In `airflow/airflow/www/templates/airflow/dags.html`, line 61:
```
in <a href={{ get_docs_url("installing/upgrading.html") }}><b>Upgrading</b></a>.
```
to
```
in <a href={{ get_docs_url("installation/upgrading.html") }}><b>Upgrading</b></a>.
```
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on issue #19581: Miscellaneous documentation typos
Posted by GitBox <gi...@apache.org>.
boring-cyborg[bot] commented on issue #19581:
URL: https://github.com/apache/airflow/issues/19581#issuecomment-968279489
Thanks for opening your first issue here! Be sure to follow the issue template!
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on issue #19581: Miscellaneous documentation typos
Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #19581:
URL: https://github.com/apache/airflow/issues/19581#issuecomment-970352862
@easontm - it's equally easy to submit your onw change. Just use "Suggest a change on this page" button at bottom-right of the page and it will open a PR for you that you will be able to submit using GitHub UI - as easy as commenting on the issue.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk edited a comment on issue #19581: Miscellaneous documentation typos
Posted by GitBox <gi...@apache.org>.
potiuk edited a comment on issue #19581:
URL: https://github.com/apache/airflow/issues/19581#issuecomment-970352862
@easontm - it's equally easy to submit your own change. Just use "Suggest a change on this page" button at bottom-right of the page and it will open a PR for you that you will be able to submit using GitHub UI - as easy as commenting on the issue.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org