question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Automatic reference to configuration reference docs

See original GitHub issue

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. Screenshot 2020-08-09 at 13 48 55 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

Issue Analytics

  • State:open
  • Created 3 years ago
  • Reactions:1
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
sadielbartholomewcommented, Nov 13, 2020

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.

0reactions
mik-lajcommented, Nov 7, 2020

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

Read more comments on GitHub >

github_iconTop Results From Across the Web

Share a Configuration with Multiple Models - MathWorks
The Configuration Reference dialog box displays a read-only view of the referenced configuration SharedConfig . In the dialog box you can browse, search,...
Read more >
Creating resource references | Config Connector Documentation
A Google Cloud resource created with Config Connector can reference other resources. Config Connector defines these relationships through resource references.
Read more >
Add references in the Reference Manager - Visual Studio ...
In Solution Explorer, right-click the References or Dependencies node, and then choose either Add Project Reference, Add Shared Project ...
Read more >
`.gitlab-ci.yml` keyword reference - GitLab Docs
Documentation for GitLab Community Edition, GitLab Enterprise Edition, Omnibus GitLab, and GitLab Runner.
Read more >
Configuring CircleCI
This document is a reference for the CircleCI 2.x configuration keys that are ... all. working_directory will be created automatically if it doesn't...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found