add warnings to existing Prow docs

[listx]

Part of kubernetes-sigs/prow#4.

This change just adds highly visible, almost obnoxious comments that are only visible to those who would like to make modifications to these files. The files now live in kubernetes-sigs/prow#10 under the "Legacy Snapshot" subdirectory.

The next phase of this migration likely involves "promoting" each file out of the "Legacy Snapshot" directory there to a less "Legacy ..."-sounding path, and once that's done, deleting the original file here so as to force users to use docs.prow.k8s.io as the source of truth.

/assign @cjwagner

[cjwagner]

I think this is a perfect use case for the blockade plugin. It allows us to block PRs from merging if they touch certain file paths. You can find a example config in the "details" here.

[listx]

here

Indeed! Let me update this to use the plugin. I think I'll still leave the topmost comment in each file explaining why the file is "blocked", but otherwise remove the other "obnoxious" lines.

EDIT: It appears the blockade plugin can be configured to post a comment explaining the rationale behind the blockade, so discard my last sentence.

[cjwagner]

/hold

[cjwagner]

I suspect we'll want some exceptions. In particular we're definitely still going to want a README for Prow as a whole, even if it only really points to the documentation site. We might want other READMEs too? WDYT?

We can tweak this later so we don't need to determine this now.

[listx]

Exception for main Prow README sounds fine. I'm not sure which other ones need exceptions, so I'd rather leave that up to future PRs as they come up.

[listx]

Added exception for prow/README.md.

[cjwagner]

/unhold

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cjwagner, listx

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• config/OWNERS [cjwagner,listx]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[k8s-ci-robot]

@listx: Updated the plugins configmap in namespace default at cluster test-infra-trusted using the following files:

• key plugins.yaml using file config/prow/plugins.yaml

Details

In response to this:

Part of kubernetes-sigs/prow#4.

This change just adds highly visible, almost obnoxious comments that are only visible to those who would like to make modifications to these files. The files now live in kubernetes-sigs/prow#10 under the "Legacy Snapshot" subdirectory.

The next phase of this migration likely involves "promoting" each file out of the "Legacy Snapshot" directory there to a less "Legacy ..."-sounding path, and once that's done, deleting the original file here so as to force users to use docs.prow.k8s.io as the source of truth.

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