Test-infra: prow: deck: serve doc for configuration options for plugins

Created on 16 Aug 2018 · 21Comments · Source: kubernetes/test-infra

Would be awesome to be able to serve doc from the deck plugin catalog for the YAML configuration that each plugin accepts.

/area prow
/area prow/deck
/kind documentation
/cc @cjwagner @BenTheElder @fejta

areprow help wanted kindocumentation lifecyclfrozen sitesting

Source

stevekuznetsov

👍1

Most helpful comment

/assign

clarketm on 16 Jul 2019

❤2

All 21 comments

This would be a nice addition. PluginHelp already includes details about the current configuration so it makes sense to extend that to describe the configuration options more generally and potentially provide example YAML snippets.

We should consider providing a link to the config.yaml source for the instance so that it is obvious which file holds the config for the Prow instance.

cjwagner on 17 Aug 2018

We should consider providing a link to the config.yaml source for the instance so that it is obvious which file holds the config for the Prow instance.

+100

stevekuznetsov on 17 Aug 2018

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

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

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

fejta-bot on 14 Nov 2018

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

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

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

fejta-bot on 15 Dec 2018

/help

cjwagner on 27 Dec 2018

/remove-lifecycle stale

idealhack on 28 Dec 2018

/remove-lifecycle rotten

idealhack on 28 Dec 2018

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

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

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

fejta-bot on 28 Mar 2019

/lifecycle frozen

idealhack on 28 Mar 2019

/assign

clarketm on 16 Jul 2019

❤2

@stevekuznetsov / @cjwagner / @idealhack - regarding implementation (more specifically UX/UI) is the goal here to simply provide a href out to a static example yaml configuration for each plugin (either in Github repo or hosted via deck), or should we take this an additional step and add a snippet of yaml to the UI component for each plugin?

clarketm on 17 Jul 2019

Are you asking if we should embed the YAML in the UI instead of just providing a link to it? Embedding in the UI would certainly be preferable.

cjwagner on 17 Jul 2019

👍1

@cjwagner - Yes. At the minimum, I was planning on linking to the hosted file, but I wanted to ensure that additionally adding a formatted yaml snippet to the UI was the desired intent as that is how I envision the feature being most useful.

clarketm on 17 Jul 2019

👍1

/milestone v1.16

spiffxp on 24 Jul 2019

/remove-help

clarketm on 27 Aug 2019

/help
This has been done for the approve plugin, if someone wanted to help they could put in similar snippets for other plugins by following @clarketm's example https://github.com/kubernetes/test-infra/pull/13507/files#diff-fafcffa198880e235687b288b620bcb8

spiffxp on 10 Apr 2020

@spiffxp:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help
This has been done for the approve plugin, if someone wanted to help they could put in similar snippets for other plugins by following @clarketm's example https://github.com/kubernetes/test-infra/pull/13507/files#diff-fafcffa198880e235687b288b620bcb8

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.