weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
e8d0d21164
cert-manager/docs
History
jetstack-ci-bot e8d0d21164
Merge pull request #382 from whereisaaron/patch-1 
Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>.

Document common ingressShim.extraArgs use case in chart

**What this PR does / why we need it**:

Lots of new users don't realize:
(a) They need to create a Issuer/ClusterIssuer themselves
(b) They need to tell `ingress-shim` the name via `extra-args`
This PR adds a comment to the helm chart `values.yaml` to address these issues.

(Ideally the `helm` would create an ClusterIssuer for you by default, and set these options, if you specify and email address to use with LE.)

Release note:
```release-note
NONE
```
2018-03-12 10:28:06 +00:00
..
api-types Add missing apiVersion to Issuer sample docs 2018-03-08 13:17:36 +00:00
deploy Bump chart version and run ./hack/update-deploy-gen.sh again 2018-03-09 22:40:16 -05:00
devel docs/devel: add 'deploy to minikube' docs 2018-03-05 17:09:50 -08:00
examples docs/examples: fix typo in example cert 2018-03-05 17:09:51 -08:00
user-guides Merge pull request #351 from jonboulle/master 2018-03-12 10:14:09 +00:00
high-level-overview.png Add high level overview diagram 2017-09-04 15:52:37 +01:00
README.md Add links to new documentation content 2018-01-18 17:44:05 +00:00

README.md

cert-manager documentation

This is the extended documentation page for cert-manager, containing detailed specification of API types, user guides, and developer documentation.

It is split into these three sections for easier navigation.

API types

User guides

Developer docs

Developer documentation can be found in the devel/ directory (coming soon).