Skip to content

Commit 2e170bb

Browse files
committed
chore(docs): Add backticks
Signed-off-by: Josh Soref <[email protected]>
1 parent 3b6b531 commit 2e170bb

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

content/docs/usage/gateway.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -345,20 +345,20 @@ spec:
345345

346346
## Supported Annotations
347347

348-
If you are migrating to Gateway resources from Ingress resources, be aware that
348+
If you are migrating to `Gateway` resources from `Ingress` resources, be aware that
349349
there are some differences between [the annotations for Ingress resources](./ingress.md#supported-annotations)
350-
versus the annotations for Gateway resources.
350+
versus the annotations for `Gateway` resources.
351351

352-
The Gateway resource supports the following annotations for generating
353-
Certificate resources:
352+
The `Gateway` resource supports the following annotations for generating
353+
`Certificate` resources:
354354

355355
- `cert-manager.io/issuer`: the name of the Issuer that should issue the
356-
certificate required for this Gateway. The Issuer _must_ be in the same
357-
namespace as the Gateway resource.
356+
certificate required for this `Gateway`. The Issuer _must_ be in the same
357+
namespace as the `Gateway` resource.
358358

359-
- `cert-manager.io/cluster-issuer`: the name of a cert-manager.io ClusterIssuer
360-
to acquire the certificate required for this Gateway. It does not matter in
361-
which namespace your Gateway resides, as `ClusterIssuers` are non-namespaced
359+
- `cert-manager.io/cluster-issuer`: the name of a `cert-manager.io` `ClusterIssuer`
360+
to acquire the certificate required for this `Gateway`. It does not matter in
361+
which namespace your `Gateway` resides, as `ClusterIssuers` are non-namespaced
362362
resources.
363363

364364
- `cert-manager.io/issuer-kind`: the kind of the external issuer resource, for

content/docs/usage/ingress.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -53,26 +53,26 @@ spec:
5353
5454
## Supported Annotations
5555
56-
You can specify the following annotations on Ingress resources in order to
57-
trigger Certificate resources to be automatically created:
56+
You can specify the following annotations on `Ingress` resources in order to
57+
trigger `Certificate` resources to be automatically created:
5858

5959
- `cert-manager.io/issuer`: the name of the Issuer that should issue the
60-
certificate required for this Ingress.
60+
certificate required for this `Ingress`.
6161

6262
> ⚠️ This annotation does _not_ assume a namespace scoped issuer. It will
63-
default to cert-manager.io Issuer, however in case of external issuer types,
63+
default to `cert-manager.io` `Issuer`, however in case of external issuer types,
6464
this should be used for both namespaced and cluster scoped issuer types.
6565

6666
> ⚠️ If a namespace scoped issuer is used then the issuer *must* be in
67-
the same namespace as the Ingress resource.
67+
the same namespace as the `Ingress` resource.
6868

69-
- `cert-manager.io/cluster-issuer`: the name of a cert-manager.io ClusterIssuer
70-
to acquire the certificate required for this Ingress. It does not matter in
71-
which namespace your Ingress resides, as `ClusterIssuers` are non-namespaced
69+
- `cert-manager.io/cluster-issuer`: the name of a `cert-manager.io` `ClusterIssuer`
70+
to acquire the certificate required for this `Ingress`. It does not matter in
71+
which namespace your `Ingress` resides, as `ClusterIssuers` are non-namespaced
7272
resources.
7373

7474
> ⚠️ This annotation is a shortcut to refer to to
75-
cert-manager.io ClusterIssuer without having to specify group and kind. It is
75+
`cert-manager.io` `ClusterIssuer` without having to specify group and kind. It is
7676
_not_ intended to be used to specify an external cluster-scoped issuer- please
7777
use `cert-manager.io/issuer` annotation for those.
7878

@@ -103,7 +103,7 @@ trigger Certificate resources to be automatically created:
103103
`"cert-manager.io/issue-temporary-certificate": "true"` onto created
104104
certificates which will cause a [temporary
105105
certificate](../usage/certificate.md#temporary-certificates-whilst-issuing) to be set
106-
on the resulting Secret until the final signed certificate has been returned.
106+
on the resulting `Secret` until the final signed certificate has been returned.
107107
This is useful for keeping compatibility with the `ingress-gce` component.
108108

109109
- `cert-manager.io/common-name`: (optional) this annotation allows you to
@@ -248,11 +248,11 @@ In the above example, cert-manager will create `Certificate` resources that
248248
reference the `ClusterIssuer` `letsencrypt-prod` for all Ingresses that have a
249249
`kubernetes.io/tls-acme: "true"` annotation.
250250
251-
Issuers configured via specific annotations have a preference over the default issuer. If a default issuer is configured via CLI flags and a `cert-manager.io/cluster-issuer` or `cert-manager.io/issuer` annotation also has been added to an Ingress, the created `Certificate` will refer to the issuer configured via annotation.
251+
Issuers configured via specific annotations have a preference over the default issuer. If a default issuer is configured via CLI flags and a `cert-manager.io/cluster-issuer` or `cert-manager.io/issuer` annotation also has been added to an `Ingress`, the created `Certificate` will refer to the issuer configured via annotation.
252252
253253
When `kubernetes.io/tls-acme: "true"` hasn't been set, automatic certificate deployment may still occur based on the `cert-manager.io/issuer`, `cert-manager.io/issuer-kind`, and `cert-manager.io/issuer-group` annotations.
254254
255-
If all annotations are absent, then manual deployment is necessary: create Certificate resources directly, and assign the resulting Secret to the Ingress.
255+
If all annotations are absent, then manual deployment is necessary: create Certificate resources directly, and assign the resulting `Secret` to the `Ingress`.
256256
257257
For more information on deploying cert-manager, read the [installation
258258
guide](../installation/README.md).

0 commit comments

Comments
 (0)