Skip to content

feat: Add prefix to custom frontmatter in Hugo archetypes #467

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.

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2025

Conversation

ADubhlaoich
Copy link
Contributor

Proposed changes

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.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

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.
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner April 29, 2025 15:19
@github-actions github-actions bot added the tooling Back end, repository, Hugo, and all things not related to content label Apr 29, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/467/

@ADubhlaoich ADubhlaoich merged commit 7c72e37 into main Apr 29, 2025
9 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/update-archetype-frontmatter branch April 29, 2025 15:22
weli02 pushed a commit to weli02/documentation that referenced this pull request Apr 30, 2025
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tooling Back end, repository, Hugo, and all things not related to content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants