Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readthedocs documentation rewrite #428

Merged
merged 12 commits into from
Apr 11, 2018
Merged

readthedocs documentation rewrite #428

merged 12 commits into from
Apr 11, 2018

Conversation

munnerz
Copy link
Member

@munnerz munnerz commented Apr 4, 2018

What this PR does / why we need it:

Updates our documentation to be written with rst and published on readthedocs.

Which issue this PR fixes: fixes #412

Special notes for your reviewer:

You can view a published copy of the site here: http://cert-manager.readthedocs.io/en/latest/

This is still WIP, and I've not finished porting across all the old user guides to the new format yet.

Keen to hear feedback 馃槃

Release note:

Rewrite documentation and publish on readthedocs

@munnerz munnerz added the kind/documentation Categorizes issue or PR as related to documentation. label Apr 4, 2018
@jetstack-bot jetstack-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Apr 4, 2018
@jetstack-bot jetstack-bot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Apr 6, 2018
@jetstack-bot jetstack-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 11, 2018
@munnerz
Copy link
Member Author

munnerz commented Apr 11, 2018

/test e2e v1.7

@munnerz munnerz added approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. labels Apr 11, 2018
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by:

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@jetstack-bot jetstack-bot merged commit c26d937 into cert-manager:master Apr 11, 2018
@euank euank mentioned this pull request Apr 16, 2018
Closed
munnerz added a commit to munnerz/charts-1 that referenced this pull request May 24, 2018
@munnerz
cert-manager: fast-forward to upstream 1e606b3e
4c04b32 
* Bump chart and manifests for v0.3.0 release (cert-manager/cert-manager#575)
* add pod labels (cert-manager/cert-manager#563)
* Add leaderElection.namespace option to helm chart (cert-manager/cert-manager#548)
* Add clusterResourceNamespace option to Helm chart (cert-manager/cert-manager#547)
* Fix ingress-shim cli flags (cert-manager/cert-manager#526)
* Create chart OWNERS (cert-manager/cert-manager#528)
* Link ingress-shim into main controller binary (cert-manager/cert-manager#502)
* readthedocs documentation rewrite (cert-manager/cert-manager#428)
* add selector, as otherwise it fails on GKE k8s v1.9.x (cert-manager/cert-manager#440)
* Add podAnnotations (cert-manager/cert-manager#387)
* Document common ingressShim.extraArgs use case in chart (cert-manager/cert-manager#382)
* Helm Chart: Add support for affinity and tolerations (cert-manager/cert-manager#350)
* Set default cluster resource namespace to current pod namespace (cert-manager/cert-manager#329)
* Create a Namespace resource as part of the static manifest bundle (cert-manager/cert-manager#340)
* Add default shortNames to certificates CRD (cert-manager/cert-manager#312)
* fix: Use ConfigMaps for leaderelection (cert-manager/cert-manager#327)
@munnerz munnerz mentioned this pull request May 24, 2018
Merged
k8s-ci-robot pushed a commit to helm/charts that referenced this pull request May 24, 2018
@munnerz @k8s-ci-robot
cert-manager: fast-forward to upstream 1e606b3e (#5744)
cc8e3fd 
* Bump chart and manifests for v0.3.0 release (cert-manager/cert-manager#575)
* add pod labels (cert-manager/cert-manager#563)
* Add leaderElection.namespace option to helm chart (cert-manager/cert-manager#548)
* Add clusterResourceNamespace option to Helm chart (cert-manager/cert-manager#547)
* Fix ingress-shim cli flags (cert-manager/cert-manager#526)
* Create chart OWNERS (cert-manager/cert-manager#528)
* Link ingress-shim into main controller binary (cert-manager/cert-manager#502)
* readthedocs documentation rewrite (cert-manager/cert-manager#428)
* add selector, as otherwise it fails on GKE k8s v1.9.x (cert-manager/cert-manager#440)
* Add podAnnotations (cert-manager/cert-manager#387)
* Document common ingressShim.extraArgs use case in chart (cert-manager/cert-manager#382)
* Helm Chart: Add support for affinity and tolerations (cert-manager/cert-manager#350)
* Set default cluster resource namespace to current pod namespace (cert-manager/cert-manager#329)
* Create a Namespace resource as part of the static manifest bundle (cert-manager/cert-manager#340)
* Add default shortNames to certificates CRD (cert-manager/cert-manager#312)
* fix: Use ConfigMaps for leaderelection (cert-manager/cert-manager#327)
cesaralbloz pushed a commit to cesaralbloz/charts that referenced this pull request May 25, 2018
@munnerz
cert-manager: fast-forward to upstream 1e606b3e (helm#5744)
ff48906 
* Bump chart and manifests for v0.3.0 release (cert-manager/cert-manager#575)
* add pod labels (cert-manager/cert-manager#563)
* Add leaderElection.namespace option to helm chart (cert-manager/cert-manager#548)
* Add clusterResourceNamespace option to Helm chart (cert-manager/cert-manager#547)
* Fix ingress-shim cli flags (cert-manager/cert-manager#526)
* Create chart OWNERS (cert-manager/cert-manager#528)
* Link ingress-shim into main controller binary (cert-manager/cert-manager#502)
* readthedocs documentation rewrite (cert-manager/cert-manager#428)
* add selector, as otherwise it fails on GKE k8s v1.9.x (cert-manager/cert-manager#440)
* Add podAnnotations (cert-manager/cert-manager#387)
* Document common ingressShim.extraArgs use case in chart (cert-manager/cert-manager#382)
* Helm Chart: Add support for affinity and tolerations (cert-manager/cert-manager#350)
* Set default cluster resource namespace to current pod namespace (cert-manager/cert-manager#329)
* Create a Namespace resource as part of the static manifest bundle (cert-manager/cert-manager#340)
* Add default shortNames to certificates CRD (cert-manager/cert-manager#312)
* fix: Use ConfigMaps for leaderelection (cert-manager/cert-manager#327)
or1can pushed a commit to or1can/charts that referenced this pull request Jul 10, 2018
@munnerz @or1can
cert-manager: fast-forward to upstream 1e606b3e (helm#5744)
f416fe8 
* Bump chart and manifests for v0.3.0 release (cert-manager/cert-manager#575)
* add pod labels (cert-manager/cert-manager#563)
* Add leaderElection.namespace option to helm chart (cert-manager/cert-manager#548)
* Add clusterResourceNamespace option to Helm chart (cert-manager/cert-manager#547)
* Fix ingress-shim cli flags (cert-manager/cert-manager#526)
* Create chart OWNERS (cert-manager/cert-manager#528)
* Link ingress-shim into main controller binary (cert-manager/cert-manager#502)
* readthedocs documentation rewrite (cert-manager/cert-manager#428)
* add selector, as otherwise it fails on GKE k8s v1.9.x (cert-manager/cert-manager#440)
* Add podAnnotations (cert-manager/cert-manager#387)
* Document common ingressShim.extraArgs use case in chart (cert-manager/cert-manager#382)
* Helm Chart: Add support for affinity and tolerations (cert-manager/cert-manager#350)
* Set default cluster resource namespace to current pod namespace (cert-manager/cert-manager#329)
* Create a Namespace resource as part of the static manifest bundle (cert-manager/cert-manager#340)
* Add default shortNames to certificates CRD (cert-manager/cert-manager#312)
* fix: Use ConfigMaps for leaderelection (cert-manager/cert-manager#327)
voron pushed a commit to dysnix/helm-charts that referenced this pull request Sep 5, 2018
@munnerz
cert-manager: fast-forward to upstream 1e606b3e (helm#5744)
aa3bc39 
* Bump chart and manifests for v0.3.0 release (cert-manager/cert-manager#575)
* add pod labels (cert-manager/cert-manager#563)
* Add leaderElection.namespace option to helm chart (cert-manager/cert-manager#548)
* Add clusterResourceNamespace option to Helm chart (cert-manager/cert-manager#547)
* Fix ingress-shim cli flags (cert-manager/cert-manager#526)
* Create chart OWNERS (cert-manager/cert-manager#528)
* Link ingress-shim into main controller binary (cert-manager/cert-manager#502)
* readthedocs documentation rewrite (cert-manager/cert-manager#428)
* add selector, as otherwise it fails on GKE k8s v1.9.x (cert-manager/cert-manager#440)
* Add podAnnotations (cert-manager/cert-manager#387)
* Document common ingressShim.extraArgs use case in chart (cert-manager/cert-manager#382)
* Helm Chart: Add support for affinity and tolerations (cert-manager/cert-manager#350)
* Set default cluster resource namespace to current pod namespace (cert-manager/cert-manager#329)
* Create a Namespace resource as part of the static manifest bundle (cert-manager/cert-manager#340)
* Add default shortNames to certificates CRD (cert-manager/cert-manager#312)
* fix: Use ConfigMaps for leaderelection (cert-manager/cert-manager#327)

Signed-off-by: voron <av@arilot.com>
@damienwebdev damienwebdev mentioned this pull request Sep 18, 2018
Merged
@munnerz munnerz deleted the rst-docs branch January 29, 2019 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

readthedocs documentation site
3 participants
@munnerz @jetstack-bot @kragniz