Sandbox process #269
Merged
Sandbox process #269
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
Fix to sandbox updates
sandbox-doc-primer.md defines terms and outlines a process for getting started with project documentation in CNCF. Signed-off-by: Dave Welsch <[email protected]>
Signed-off-by: Nate W <[email protected]>
docs/sandbox-doc-primer.md
Outdated
Comment on lines
204
to
205
| [Open Source Documentation Essentials](https://training.linuxfoundation.org/training/open-source-technical-documentation-essentials-lfc111/) | ||
| [Creating Effective Documentation for Developers](https://training.linuxfoundation.org/training/creating-effective-documentation-for-developers-lfc112/) |
There was a problem hiding this comment.
@chalin, the linter is barking at these two lines (too long). How should we handle long url lines (or how can I tell the linter it's OK in this case?)
There was a problem hiding this comment.
@nate-double-u @chalin Problem seems to have been spaces at the ends of the lines. These two lines seem to be behaving now (the rule seems to be that links are exceptions to the 80-character line length limit). However, there's another formatter failure now caused by a Prettier violation. Is there a way to get Prettier to give more informative error messages?
- Added release notes as an example of reference doc - Added links to more resources - Minor edits Signed-off-by: Dave Welsch <[email protected]>
Fixed format issue? Signed-off-by: Dave Welsch <[email protected]>
Added info about CNCF hosting project websites. Signed-off-by: Dave Welsch <[email protected]>
Signed-off-by: Nate W <[email protected]>
nate-double-u
approved these changes
Aug 7, 2024
There was a problem hiding this comment.
Thanks for this @dwelsch-esi!
We can make changes as feedback comes in if we'd like, but this is a great primer as is.
Dindihub
pushed a commit
to Dindihub/TUF-docs-analysis
that referenced
this pull request
Aug 10, 2024
* Added sandbox doc primer sandbox-doc-primer.md defines terms and outlines a process for getting started with project documentation in CNCF. Signed-off-by: Dave Welsch <[email protected]> * fixing formatting Signed-off-by: Nate W <[email protected]> * Update sandbox-doc-primer.md - Added release notes as an example of reference doc - Added links to more resources - Minor edits Signed-off-by: Dave Welsch <[email protected]> * Update sandbox-doc-primer.md Fixed format issue? Signed-off-by: Dave Welsch <[email protected]> * Update sandbox-doc-primer.md Added info about CNCF hosting project websites. Signed-off-by: Dave Welsch <[email protected]> * fixing formatting Signed-off-by: Nate W <[email protected]> --------- Signed-off-by: Dave Welsch <[email protected]> Signed-off-by: Nate W <[email protected]> Co-authored-by: Nate W <[email protected]>
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.
Adding the "sandbox documentation primer"