kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add instructions to README

This commit is contained in:
Jamie Hannaford 2017-10-05 12:00:13 +01:00
parent 6bda727b83
commit 3050dc02de
2 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/PULL_REQUEST_TEMPLATE vendored
View File

@ -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
2. Generate docs with `make generate`. To build docs for one sig, run `make WHAT=sig-apps generate`
-->

5
README.md
View File

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