weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #1065 from heckj/docs-cleanup

Browse Source 
Docs cleanup
This commit is contained in:
jetstack-bot 2018-11-13 11:17:00 +00:00 committed by GitHub
commit 1a4e51f753
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/devel/dco-sign-off.rst
View File

@ -20,7 +20,7 @@ You can also mass sign-off a whole PR with ``git rebase --signoff master``,
replacing ``master`` with the branch you are creating a pull request again if
not master.
By doing this you state that you can certify the following (from https://developercertificate.org/):
By doing this you state that you certify the following (from https://developercertificate.org/):
.. code::

11
docs/devel/generate-docs.rst
View File

@ -2,8 +2,10 @@
Generating Documentation
=====================
The documentation uses `Sphinx`_ (via `Read The Docs`_) to generate markdown
from `reStructured Text`_.
The documentation is generated from `reStructured Text`_ by `Sphinx`_
(via `Read The Docs`_). If you're unfamiliar with `reStructured Text`_,
the files typically have the extension `.rst`. You can find more details
in the `reStructured Text Basics`_.
Installation instructions
=========================
@ -29,6 +31,7 @@ open with your browser.
Note that you do not need to add these files to your git client, as
*Read The Docs* will generate the HTML on the fly.
.. _`Sphinx`: http://www.sphinx-doc.org/
.. _`Sphinx`: https://www.sphinx-doc.org/
.. _`Read The Docs`: https://readthedocs.org/
.. _`reStructured Text`: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
.. _`reStructured Text`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
.. _`reStructured Text Basics`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

1
docs/reference/issuers/acme/http01.rst
View File

@ -29,6 +29,7 @@ using Ingress resources
In rare cases it might be not possible/desired to use NodePort as type for the http01 challenge response service, e.g. because of Kubernetes limit restrictions. To define which Kubernetes service type to use during challenge response specify the following http01 config
.. code-block:: yaml
http01:
# Valid values are ClusterIP and NodePort
serviceType: ClusterIP