From 4c7d9b8256aa838e67e3ddd3a65e99f13099b3e1 Mon Sep 17 00:00:00 2001 From: Rebecca Tamachiro Date: Thu, 26 Dec 2024 12:35:26 +0000 Subject: [PATCH 1/5] Remove DNS records from table of monospaced items --- .../docs/style-guide/formatting/code-conventions-and-format.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx b/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx index d36e543cf68895..f3b6c28d16f40e 100644 --- a/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx +++ b/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx @@ -103,7 +103,6 @@ Text in this font denotes text or characters that you should enter from the keyb | Command-line utility names | `wrangler`, `npm`, `node`, `cloudflared` | | Data types | (`string`, `number`, `int64`) | | Defined (constant) values for an element or attribute | `` | -| DNS record types | The bot will default to looking for `AAAA` records. | | Enum (enumerator) names (depending on language) | `type ContentTypeMapElem` | | Environment variable names | `` | | Element names, including angle brackets (XML and HTML). | `
`, `
`, ``, `` | From 0d8f467e897963b7ee93b3d7ae0b26169e86d6c9 Mon Sep 17 00:00:00 2001 From: Rebecca Tamachiro Date: Thu, 26 Dec 2024 12:59:18 +0000 Subject: [PATCH 2/5] Create specific guidance for DNS record types formatting --- .../style-guide/formatting/dns-record-types.mdx | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 src/content/docs/style-guide/formatting/dns-record-types.mdx diff --git a/src/content/docs/style-guide/formatting/dns-record-types.mdx b/src/content/docs/style-guide/formatting/dns-record-types.mdx new file mode 100644 index 00000000000000..52d9e04fe5b635 --- /dev/null +++ b/src/content/docs/style-guide/formatting/dns-record-types.mdx @@ -0,0 +1,15 @@ +--- +pcx_content_type: concept +title: DNS record types + +--- + +As a general rule, do not use [monospace](/style-guide/formatting/code-conventions-and-format/#monospace) for DNS record types. Use regular text formatting and write the record type in uppercase. + +You may use monospace for clarity when referring to [IPv4 records (known as A records)](/dns/manage-dns-records/reference/dns-record-types/#a-and-aaaa), or when specifying record types in [procedures](/style-guide/documentation-content-strategy/component-attributes/steps-tasks-procedures/). However, for most cases, use regular text formatting and restructure the sentences to avoid ambiguity. + +Examples: + +* A and AAAA records map a domain name to one or multiple IPv4 or IPv6 addresses. +* You can use CNAME records to point to other CNAME records. +* Select `A`, `AAAA`, or `CNAME` as the record **Type**, according to your needs. (Procedure) From 071f41937130bb70ab3f1bfec1aa1ae606771093 Mon Sep 17 00:00:00 2001 From: Rebecca Tamachiro Date: Thu, 2 Jan 2025 15:06:28 +0000 Subject: [PATCH 3/5] Revert "Create specific guidance for DNS record types formatting" This reverts commit 0d8f467e897963b7ee93b3d7ae0b26169e86d6c9. --- .../style-guide/formatting/dns-record-types.mdx | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 src/content/docs/style-guide/formatting/dns-record-types.mdx diff --git a/src/content/docs/style-guide/formatting/dns-record-types.mdx b/src/content/docs/style-guide/formatting/dns-record-types.mdx deleted file mode 100644 index 52d9e04fe5b635..00000000000000 --- a/src/content/docs/style-guide/formatting/dns-record-types.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -pcx_content_type: concept -title: DNS record types - ---- - -As a general rule, do not use [monospace](/style-guide/formatting/code-conventions-and-format/#monospace) for DNS record types. Use regular text formatting and write the record type in uppercase. - -You may use monospace for clarity when referring to [IPv4 records (known as A records)](/dns/manage-dns-records/reference/dns-record-types/#a-and-aaaa), or when specifying record types in [procedures](/style-guide/documentation-content-strategy/component-attributes/steps-tasks-procedures/). However, for most cases, use regular text formatting and restructure the sentences to avoid ambiguity. - -Examples: - -* A and AAAA records map a domain name to one or multiple IPv4 or IPv6 addresses. -* You can use CNAME records to point to other CNAME records. -* Select `A`, `AAAA`, or `CNAME` as the record **Type**, according to your needs. (Procedure) From d3ffba351c18d9f9e26db41a9fe3119846409efb Mon Sep 17 00:00:00 2001 From: Rebecca Tamachiro Date: Thu, 2 Jan 2025 15:19:04 +0000 Subject: [PATCH 4/5] Add exception to DNS records entry in monospace examples list --- .../docs/style-guide/formatting/code-conventions-and-format.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx b/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx index f3b6c28d16f40e..fcf69cb97261db 100644 --- a/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx +++ b/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx @@ -103,6 +103,7 @@ Text in this font denotes text or characters that you should enter from the keyb | Command-line utility names | `wrangler`, `npm`, `node`, `cloudflared` | | Data types | (`string`, `number`, `int64`) | | Defined (constant) values for an element or attribute | `` | +| DNS record types | The bot will default to looking for `AAAA` records.
However, you may use regular formatting (AAAA, for example) if there are multiple inline occurrences or if the text is a hyperlink. | | Enum (enumerator) names (depending on language) | `type ContentTypeMapElem` | | Environment variable names | `` | | Element names, including angle brackets (XML and HTML). | `
`, ``, ``, `` | From ba4ff306a461fbeebab88ee1fa9e09770b42d8ae Mon Sep 17 00:00:00 2001 From: Rebecca Tamachiro <62246989+RebeccaTamachiro@users.noreply.github.com> Date: Thu, 2 Jan 2025 15:49:04 +0000 Subject: [PATCH 5/5] Apply suggestion from code review Co-authored-by: Jun Lee --- .../docs/style-guide/formatting/code-conventions-and-format.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx b/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx index fcf69cb97261db..5450485a3fd28c 100644 --- a/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx +++ b/src/content/docs/style-guide/formatting/code-conventions-and-format.mdx @@ -103,7 +103,7 @@ Text in this font denotes text or characters that you should enter from the keyb | Command-line utility names | `wrangler`, `npm`, `node`, `cloudflared` | | Data types | (`string`, `number`, `int64`) | | Defined (constant) values for an element or attribute | `` | -| DNS record types | The bot will default to looking for `AAAA` records.
However, you may use regular formatting (AAAA, for example) if there are multiple inline occurrences or if the text is a hyperlink. | +| DNS record types | The bot will default to looking for `AAAA` records.
However, you may use regular formatting (for example, AAAA) if there are multiple inline occurrences or if the text is a hyperlink. | | Enum (enumerator) names (depending on language) | `type ContentTypeMapElem` | | Environment variable names | `` | | Element names, including angle brackets (XML and HTML). | `
`, ``, ``, `` |