summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJamie Hannaford <jamie@limetree.org>2017-10-05 12:00:13 +0100
committerJamie Hannaford <jamie@limetree.org>2017-10-06 15:27:20 +0100
commit3050dc02defbfac1a7cb3fed643aa1cb3114b56f (patch)
tree12d015a2bbd4762c1ac9ff64120f4d9d6beceb02
parent6bda727b83d36e9cc24e8da87bf8916e7e7b1220 (diff)
Add instructions to README
-rw-r--r--.github/PULL_REQUEST_TEMPLATE12
-rw-r--r--README.md5
2 files changed, 6 insertions, 11 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
index a902841f..2e5919db 100644
--- a/.github/PULL_REQUEST_TEMPLATE
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -3,13 +3,5 @@
- If you are editing SIG information, please follow these instructions: https://github.com/kubernetes/community/tree/master/generator
You will need to follow these steps:
1. Edit sigs.yaml with your change
- 2. Generate docs with `make all`. To build docs for one sig, run `make WHAT=sig-apps all`
--->
-
-**What this PR does**:
-
-**Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #
-
-**SIG changes**
-
-- [] If changing SIG information, I have read [these instructions](https://github.com/kubernetes/community/tree/master/generator) and re-generated the docs \ No newline at end of file
+ 2. Generate docs with `make generate`. To build docs for one sig, run `make WHAT=sig-apps generate`
+--> \ No newline at end of file
diff --git a/README.md b/README.md
index 0f3ea1ab..c28918b2 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,10 @@ A SIG can have its own policy for contribution,
described in a `README` or `CONTRIBUTING` file in the SIG
folder in this repo (e.g. [sig-cli/CONTRIBUTING](sig-cli/CONTRIBUTING.md)),
and its own mailing list, slack channel, etc.
-
+
+If you want to edit details about a SIG (e.g. its weekly meeting time or its leads),
+please follow [these instructions](./generator) that detail how our docs are auto-generated.
+
## How Can I Help?
Documentation (like the text you are reading now) can