Skip to content

feat: Update Hugo archetypes to remove HRs and change final subsection #531

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
May 7, 2025

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented May 7, 2025

Proposed changes

This commit updates the Hugo archetypes to remove the horizontal lines delineating each section, and also changes the final sections of each section. The future website theme uses meaningful whitespace for breaking sections up instead of horizontal lines, so removing it from the templates prevents more from being added.

"See also" was changed to "Next steps" for two of the archetypes, with more specific examples for all three. This reflects discussions around the fact that "See also" doesn't inspire informed content design.

"Next steps" is more appropriate for specific use cases, especially with the context of the working document - we have a good idea of what the reader may need to do next, so the title should reflect that.

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.

This commit updates the Hugo archetypes to remove the horizontal lines
delineating each section, and also changes the final sections of each
section. The future website theme uses meaningful whitespace for
breaking sections up instead of horizontal lines, so removing it from
the templates prevents more from being added.

"See also" was changed to "Next steps" for two of the archetypes, with
more specific examples for all three. This reflects discussions around
the fact that "See also" doesn't inspire informed content design.

"Next steps" is more appropriate for specific use cases, especially with
the context of the working document - we have a good idea of what the
reader may need to do next, so the title should reflect that.
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner May 7, 2025 11:54
@github-actions github-actions bot added the tooling Back end, repository, Hugo, and all things not related to content label May 7, 2025
Copy link

github-actions bot commented May 7, 2025

Deploy Preview will be available once build job completes!

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

@ADubhlaoich ADubhlaoich merged commit 142e4ec into main May 7, 2025
9 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/remove-archetype-hrs branch May 7, 2025 12:45
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.

2 participants