Skip to content

Commit 7c72e37

Browse files
authored
feat: Add prefix to custom frontmatter in Hugo archetypes (#467)
To reduce name collisions and make it explicitly clear which frontmatter fields are used by DocOps (As opposed to native Hugo fields which interact with specific mechanisms), this PR adds an `nd` prefix. This ensures that documents generated using `hugo new` will have the correct fields in the future. Follow up work to update existing fields and documents will be handled in other pull requests.
1 parent f8651bc commit 7c72e37

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

archetypes/concept.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ weight: i00
66
# Creates a table of contents and sidebar, useful for large documents
77
toc: false
88
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
9-
type: concept
9+
nd-content-type: concept
1010
# Intended for internal catalogue and search, case sensitive:
1111
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12-
product:
12+
nd-product:
1313
---
1414

1515
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."

archetypes/default.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ weight: i00
66
# Creates a table of contents and sidebar, useful for large documents
77
toc: false
88
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
9-
type: how-to
9+
nd-content-type: how-to
1010
# Intended for internal catalogue and search, case sensitive:
1111
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12-
product:
12+
nd-product:
1313
---
1414

1515
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."

archetypes/tutorial.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ weight: i00
66
# Creates a table of contents and sidebar, useful for large documents
77
toc: false
88
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
9-
type: tutorial
9+
nd-content-type: tutorial
1010
# Intended for internal catalogue and search, case sensitive:
1111
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12-
product:
12+
nd-product:
1313
---
1414

1515
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."

0 commit comments

Comments
 (0)