feat: Fix minor issues, add docs contribution quickstart. #3337
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 addresses two issues flagged as problems in documentation. One is a small typo, the other is an incorrect link. Additionally, it adds a README to the docs subfolder to explain how to run a local Hugo instance for testing and the broad strokes of contributing.
for more information, see https://pre-commit.ci
ADubhlaoich
commented
Dec 6, 2022
Fix single letter typo. Signed-off-by: Alan Dooley <[email protected]>
jjngx
approved these changes
Dec 6, 2022
'namespaces' is erroneously spelled 'namespacess'
jputrino
reviewed
Dec 7, 2022
jputrino
reviewed
Dec 7, 2022
jputrino
reviewed
Dec 7, 2022
jputrino
reviewed
Dec 7, 2022
jputrino
approved these changes
Dec 7, 2022
Codecov Report
@@ Coverage Diff @@
## main #3337 +/- ##
==========================================
- Coverage 51.58% 51.56% -0.03%
==========================================
Files 60 60
Lines 16675 16675
==========================================
- Hits 8602 8598 -4
- Misses 7783 7785 +2
- Partials 290 292 +2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
This commit axes the guidance around the content style completely and clarifies the instructions for Hugo, also mentioning the live reload feature it has - which is useful when working on documentation.
for more information, see https://pre-commit.ci
lucacome
reviewed
Dec 10, 2022
Co-authored-by: Luca Comellini <[email protected]> Signed-off-by: Alan Dooley <[email protected]>
In a previous commit, this link was erroneously changed based on a report. Links should point to the latest release tag, and the correction given was for a different document altogether.
ADubhlaoich
commented
Jan 4, 2023
lucacome
approved these changes
Jan 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
This commit addresses two issues flagged as problems in documentation. One is a small typo, the other is an incorrect link. Additionally, it adds a README to the docs subfolder to explain how to run a local Hugo instance for testing and the broad strokes of contributing.
Checklist
Before creating a PR, run through this checklist and mark each as complete.