Skip to content

Commit

Permalink
improve titles
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Ramlot <[email protected]>
  • Loading branch information
inteon committed Oct 12, 2023
1 parent d9a71b1 commit ebbb764
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 5 deletions.
4 changes: 4 additions & 0 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -656,6 +656,10 @@ arukiidou
Richardds
kahirokunn
selfsigned-issuer
apiVersion
gateway.networking.k8s.io
networking.k8s.io
certificates.k8s.io

# TEMPORARY
# these are temporarily ignored because the spellchecker
Expand Down
5 changes: 4 additions & 1 deletion content/docs/usage/certificate.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: cert-manager.io Certificate
title: Certificate resource
description: 'cert-manager usage: Certificates'
---

> **apiVersion:** cert-manager.io/v1
> **kind:** Certificate
In cert-manager, the [`Certificate`](../concepts/certificate.md) resource
represents a human readable definition of a certificate request that is to be
honored by an issuer which is to be kept up-to-date. This is the usual way that
Expand Down
5 changes: 4 additions & 1 deletion content/docs/usage/certificaterequest.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: cert-manager.io CertificateRequest
title: CertificateRequest resource
description: 'cert-manager core concepts: CertificateRequests'
---

> **apiVersion:** cert-manager.io/v1
> **kind:** CertificateRequest
The `CertificateRequest` is a namespaced resource in cert-manager that is used
to request X.509 certificates from an [`Issuer`](../concepts/issuer.md). The resource
contains a base64 encoded string of a PEM encoded certificate request which is
Expand Down
5 changes: 4 additions & 1 deletion content/docs/usage/gateway.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: Annotated gateway.networking.k8s.io Gateway
title: Annotated Gateway resource
description: 'cert-manager usage: Kubernetes Gateways'
---

> **apiVersion:** gateway.networking.k8s.io/v1alpha2
> **kind:** Gateway
**FEATURE STATE**: cert-manager 1.5 [alpha]

<div className="info">
Expand Down
5 changes: 4 additions & 1 deletion content/docs/usage/ingress.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: Annotated networking.k8s.io Ingress
title: Annotated Ingress resource
description: 'cert-manager usage: Kubernetes Ingress'
---

> **apiVersion:** networking.k8s.io/v1
> **kind:** Ingress
A common use-case for cert-manager is requesting TLS signed certificates to
secure your ingress resources. This can be done by simply adding annotations to
your `Ingress` resources and cert-manager will facilitate creating the
Expand Down
5 changes: 4 additions & 1 deletion content/docs/usage/kube-csr.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
---
title: certificates.k8s.io CertificateSigningRequest
title: CertificateSigningRequest resource
description: 'cert-manager usage: Kubernetes CertificateSigningRequest resources'
---

> **apiVersion:** certificates.k8s.io/v1
> **kind:** CertificateSigningRequest
Kubernetes has an in-built
[CertificateSigningRequest](https://kubernetes.io/docs/reference/access-authn-authz/certificate-signing-requests/)
resource. This resource is similar to the cert-manager
Expand Down

0 comments on commit ebbb764

Please sign in to comment.