feat: Move and update process documentation #717
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit moves and updates some of the process documentation for the repository. This is an iterative process, which will continue to improve as time goes on. Some of the changes include: - Moving the closed contributions document into the documentation folder - Moving and reframing the F5/NGINX document as "Maintainers etiquette" - Moving and renaming the "Managing content with Hugo" document - Moving the style guide from the templates folder These files will likely be updated in a subsequent PR as we clarify the contribution process and user flow of other process artefacts, such as the pull request and issue templates. Although we do not draw attention to it, the templates folder is being retained for reference until the style guide and Hugo archetypes contain the relevant, useful information.
github-actions
bot
added
the
process documentation
✅ Deploy Preview will be available once build job completes!
|
ADubhlaoich
commented
Jun 20, 2025
| @@ -51,6 +52,7 @@ our documentation as described in our [support](./SUPPORT.md) page. | |||
| ### Git style guide | |||
|
|
|||
| - Keep a clean, concise and meaningful Git commit history on your branch, rebasing locally and squashing before you submit a PR | |||
There was a problem hiding this comment.
Since we squash and merge I think this guideline is somewhat moot, but partially why conventional commits are important. I have stronger opinions about this and would like the git style guide to be its own document, but it will be its own PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This commit moves and updates some of the process documentation for the repository. This is an iterative process, which will continue to improve as time goes on. Some of the changes include:
These files will likely be updated in a subsequent PR as we clarify the contribution process and user flow of other process artifacts, such as the pull request and issue templates.
Although we do not draw attention to it, the templates folder is being retained for reference until the style guide and Hugo archetypes contain the relevant, useful information.
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.mdandCHANGELOG.mdFootnotes
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. ↩