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/08/09 11:57:10 UTC

[GitHub] [airflow] mik-laj opened a new issue #10260: Automatic reference to configuration reference docs

mik-laj opened a new issue #10260:
URL: https://github.com/apache/airflow/issues/10260


   Hello,
   
   I would like it to be possible to easily refer to the reference list with configuration options.  Currently, most of the guides that require a description of configuration options are similar to the description below.
   <img width="941" alt="Screenshot 2020-08-09 at 13 48 55" src="https://user-images.githubusercontent.com/12058428/89731407-177fb500-da47-11ea-9df5-8a17b910da35.png">
   There are code literals in this text: ``backend``, ``[secrets]``. Unfortunately, these literals are just text and I wish they could be clicked to go to a reference list containing a description of the option/section.
   
   To do this, we should add a new reference type, make changes to the listing template, and then make changes to all descriptions. We can be inspired by the Django project.
   https://github.com/django/django/blob/58a336a674a658c1cda6707fe1cacb56aaed3008/docs/_ext/djangodocs.py#L47-L52
   
   Best regards,
   Kamil BreguĊ‚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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [airflow] sadielbartholomew commented on issue #10260: Automatic reference to configuration reference docs

Posted by GitBox <gi...@apache.org>.
sadielbartholomew commented on issue #10260:
URL: https://github.com/apache/airflow/issues/10260#issuecomment-705614891


   Thank you! I expect I can have the PR up by the middle of next week at the latest, hopefully sooner depending on how much spare time I get to work on some Hacktoberfest contributions. In the case it takes longer than that I will keep you updated.


----------------------------------------------------------------
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] sadielbartholomew commented on issue #10260: Automatic reference to configuration reference docs

Posted by GitBox <gi...@apache.org>.
sadielbartholomew commented on issue #10260:
URL: https://github.com/apache/airflow/issues/10260#issuecomment-726498023


   Hi @mik-laj, and the Airflow team, I'm very sorry for the delay. I ended up being snowed under with other work and didn't get much time for Hacktoberfest. However, I will be more free from next week onwards, so I can start o this next week, and hopefully finish within a week or so, but I appreciate you might want it completed earlier, in which case please unassign me and accept my apologies that I did not complete it as soon as I had hoped. Thanks.


----------------------------------------------------------------
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 issue #10260: Automatic reference to configuration reference docs

Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #10260:
URL: https://github.com/apache/airflow/issues/10260#issuecomment-705531536


   Assigned . Looking forward to having this  @sadielbartholomew !


----------------------------------------------------------------
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 issue #10260: Automatic reference to configuration reference docs

Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #10260:
URL: https://github.com/apache/airflow/issues/10260#issuecomment-705531536


   Assigned . Looking forward to having this  @sadielbartholomew !


----------------------------------------------------------------
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] sadielbartholomew commented on issue #10260: Automatic reference to configuration reference docs

Posted by GitBox <gi...@apache.org>.
sadielbartholomew commented on issue #10260:
URL: https://github.com/apache/airflow/issues/10260#issuecomment-705301904


   Hi, I have a lot of experience with developing Sphinx for documentation, so I think I can resolve this Issue if it is still available. Would you be happy to assign me, and accept my contribution as a Hacktoberfest PR should I manage to put in a PR that closes it? Thanks.


----------------------------------------------------------------
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] sadielbartholomew commented on issue #10260: Automatic reference to configuration reference docs

Posted by GitBox <gi...@apache.org>.
sadielbartholomew commented on issue #10260:
URL: https://github.com/apache/airflow/issues/10260#issuecomment-705614891


   Thank you! I expect I can have the PR up by the middle of next week at the latest, hopefully sooner depending on how much spare time I get to work on some Hacktoberfest contributions. In the case it takes longer than that I will keep you updated.


----------------------------------------------------------------
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 issue #10260: Automatic reference to configuration reference docs

Posted by GitBox <gi...@apache.org>.
mik-laj commented on issue #10260:
URL: https://github.com/apache/airflow/issues/10260#issuecomment-723480907


   @sadielbartholomew How do you do? I hope to be with you in this crazy year. I wonder if you need any help with this contribution.


----------------------------------------------------------------
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