Doc link for complicated parameters

[dimitraz]

This form is for bug reports and feature requests. Major features will go through a spec process.

Feature:

We have some slightly more involved parameters that benefit from an external link to their relative documentation. At the moment we've added full urls to the description, which doesn't seem like a great user experience.
Is there a better way to do this currently? If there isn't, would this be a feature that is likely to be accepted (e.g. a documentationUrl option for each parameter)?

cc @maleck13 @philipgough

[jmrodri]

@maleck13 to work on this

[maleck13]

@dimitraz discussed with the broker team. We will need to contact the UI team and see what can be achieved there. I think we can spike an approach to this and approach with our findings as this worked well for conditional params

from @shawn-hurley on that one, we may want to see if we could pass in something like markdown for them to render in the description of the parameter

[maleck13]

Working with @dimitraz to do a poc on how this could work from UI and broker

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[jmrodri]

/close

[openshift-ci-robot]

@jmrodri: Closing this issue.

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.