Update guidance and tooling for documentation #1431
Merged
Conversation
This file contains 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 adds a README file to the /site subfolder instructing a reader on how to build and contribute to the documentation. It introduces the tooling, explains the Makefile, then details the conventions around Hugo and Markdown usage.
github-actions
bot
added
the
documentation
|
Pushed a second commit to address the linting issues. I think attention should be drawn to the subfolder README somewhere in the CONTRIBUTING file in the base of the repo but it's unclear where. Maybe appending the /site/ folder for docs underneath "Project Structure", and the README under "Development Guide"? |
kate-osborn
reviewed
Jan 2, 2024
There was a problem hiding this comment.
@ADubhlaoich do we still need this developer doc for documentation?
This commit incorporates some feedback to the README file while also updating the Makefile to follow suit. There were some options listed that didn't actually exist and others that weren't listed.
|
Incorporated the feedback from the PR thus far, which is also reflected with changes to the Makefile itself. I have one more pass to make to merge the existing documentation README's contents into this one, at which point it should be reviewed again. |
sjberman
reviewed
Jan 5, 2024
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
ADubhlaoich
changed the title
sjberman
reviewed
Jan 8, 2024
sjberman
approved these changes
Jan 8, 2024
kate-osborn
requested changes
Jan 8, 2024
bjee19
approved these changes
Jan 9, 2024
|
@kate-osborn Any amendments? There's been other approvals. |
kate-osborn
approved these changes
Jan 10, 2024
miledxz
added a commit
to miledxz/nginx-gateway-fabric
that referenced
this pull request
Jan 14, 2025
These changes add a README file to the site subfolder instructing a reader on how to build and contribute to the documentation. It removes a similar README from the developer documentation folder while incorporating a number of improvements. With this commit there are also changes to the Makefile, with the aim of clarifying the intent and usage of certain commands. Finally, the new README references and is referenced by the general CONTRIBUTION guidelines to reflect the standardised processes and reinforce our "Docs like Code" approach. Co-authored-by: Saylor Berman <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
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 adds a README file to the /site subfolder instructing a reader on how to build and contribute to the documentation. It introduces the tooling, explains the Makefile, then details the conventions around Hugo and Markdown usage.
Addresses #1430 .
Checklist
Before creating a PR, run through this checklist and mark each as complete.