Test-infra: Document each and every prow component

[kargakis]

We had this issue coming. @fejta @cjwagner @stevekuznetsov @BenTheElder @krzyzacy @spiffxp who is up for some docs either by enhancing existing docs or on the remaining parts of prow? :)

• [ ] artifacts_uploader
• [x] [branchprotector](https://github.com/kubernetes/test-infra/blob/master/prow/cmd/branchprotector/README.md)
• [x] [clonerefs](https://github.com/kubernetes/test-infra/tree/master/prow/cmd/clonerefs/README.md)
• [ ] deck
• [x] [entrypoint](https://github.com/kubernetes/test-infra/tree/master/prow/cmd/entrypoint/README.md)
• [x] [gcsupload](https://github.com/kubernetes/test-infra/tree/master/prow/cmd/gcsupload/README.md)
• [ ] gerrit
• [ ] hook
• [ ] horologium
• [x] [initupload](https://github.com/kubernetes/test-infra/blob/master/prow/cmd/initupload/README.md)
• [x] [jenkins-operator](https://github.com/kubernetes/test-infra/blob/master/prow/cmd/jenkins-operator/README.md)
• [ ] plank
• [x] [sidecar](https://github.com/kubernetes/test-infra/blob/master/prow/cmd/sidecar/README.md)
• [ ] sinker
• [x] [tide](https://github.com/kubernetes/test-infra/tree/master/prow/cmd/tide/README.md)
• [ ] tot

/area prow
/kind documentation

[stevekuznetsov]

Hey, I did my best :)

[krzyzacy]

I'll probably add the diagram from the deep dive

[stevekuznetsov]

Would be great to add links to the Deep Dive recording, the next best thing has been the (really, really old) presentation given in sig-testing meeting about a year ago.

[sipian]

Hi,
I am looking at prow for Prometheus test & benchmarking environment.
It will be really helpful if some documentation could be provided about all the various fields in config.yaml & plugins.yaml

[kargakis]

@sipian not ideal today but you can find some documentation about those in godoc

https://godoc.org/github.com/kubernetes/test-infra/prow/config#Config
https://godoc.org/github.com/kubernetes/test-infra/prow/plugins

[fejta-bot]

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

[stevekuznetsov]

/remove-lifecycle stale

[spiffxp]

/help
FYI @cjwagner

[k8s-ci-robot]

@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
FYI @cjwagner

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.

[fejta-bot]

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]

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]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

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

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/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.