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 2022/01/14 12:32:39 UTC
[GitHub] [airflow] Limess opened a new issue #20873: Distinguish links in DAG documentation from code
Limess opened a new issue #20873:
URL: https://github.com/apache/airflow/issues/20873
### Description
Currently code blocks (i.e using backticks in markdown) look the same as links when using `dag.doc_md`.
This makes it very difficult to distinguish what is clickable in links.
For example in the image below,
`document-chunker` is a code block, whereas `offline-processing-storage-chunking-manual-trigger-v5` is a link - but they appear identical.
If this was rendered on github it'd look like:
> The restored files must subsequently be restored using a manual trigger of `document-chunker`: [offline-processing-storage-chunking-manual-trigger-v5](https://invalid-link.com), set `s3_input_base_path` as copied and provide the same start and end dates.
### Use case/motivation
We're trying to link between manual steps which are possible with Airflow runs for recovery, reducing the need to write long pieces of documentation.
The links are currently difficult to distinguish which causes issues when following instructions.
### Related issues
_No response_
### Are you willing to submit a PR?
- [ ] 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] jedcunningham commented on issue #20873: Distinguish links in DAG documentation from code
Posted by GitBox <gi...@apache.org>.
jedcunningham commented on issue #20873:
URL: https://github.com/apache/airflow/issues/20873#issuecomment-1013500431
What is your `doc_md`?
I can only reproduce this with:
```
doc_md="Test `code block` and a [`link`](https://airflow.apache.org).",
````
But if I don't use a code block in the link text (and you don't in your example), it rendered fine:
--
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] jedcunningham closed issue #20873: Distinguish links in DAG documentation from code
Posted by GitBox <gi...@apache.org>.
jedcunningham closed issue #20873:
URL: https://github.com/apache/airflow/issues/20873
--
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] jedcunningham edited a comment on issue #20873: Distinguish links in DAG documentation from code
Posted by GitBox <gi...@apache.org>.
jedcunningham edited a comment on issue #20873:
URL: https://github.com/apache/airflow/issues/20873#issuecomment-1013500431
What is your `doc_md`?
I can only reproduce this with:
```
doc_md="Test `code block` and a [`link`](https://airflow.apache.org).",
````
But if I don't use a code block in the link text (and you don't in your example), it rendered fine:
```
doc_md="Test `code block` and a [link](https://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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] Limess commented on issue #20873: Distinguish links in DAG documentation from code
Posted by GitBox <gi...@apache.org>.
Limess commented on issue #20873:
URL: https://github.com/apache/airflow/issues/20873#issuecomment-1013869114
You're correct - sorry my example was slightly wrong, it's code blocks within links which are unclear:
The screenshot above still applies, this is the Github example:
> The restored files must subsequently be restored using a manual trigger of `document-chunker`: [`offline-processing-storage-chunking-manual-trigger-v5`](https://invalid-link.com), set `s3_input_base_path` as copied and provide the same start and end dates.
Note the code block in a link is still blue: [`offline-processing-storage-chunking-manual-trigger-v5`](https://invalid-link.com)
--
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