Updating Tremor docs assessment formatting #70
Conversation
Signed-off-by: Nate W <[email protected]>
|
|
||
| **Content creation processes:** There are no content creation processes documented and no CONTRIBUTING.md file for the main docs repository. Some things to think about: | ||
| - **Content creation processes:** There are no content creation processes documented and no CONTRIBUTING.md file for the main docs repository. Some things to think about: |
There was a problem hiding this comment.
Just curious @nate-double-u: what changed in this line? Although they're not, they look the same in the online diff. Was it a change from a tab to a space or a hyphen to a dash, or some other hidden characters?
There was a problem hiding this comment.
I've added a - at the beginning of the line for consistency.
There was a problem hiding this comment.
(also, adding the - in some cases is what triggers the renderer to treat the next paragraph as a bulleted list. I thought this was the cleanest way to sort it -- we may want to revisit the template and use section H3 or H4 section headers instead in situations like this)
There was a problem hiding this comment.
(Oh, of course! Lol. I read the diff too quickly and took the diff - as a markdown list character! 🤷♂️
Right, it makes sense for consistency to include it in the list.
There was a problem hiding this comment.
One - added at the beginning of the line is a bit of a sneaky diff...
|
And thanks for the link to the "deploy preview"! |
Deploy preview: https://github.com/nate-double-u/cncf-techdocs/blob/tremor-assessment-formatting/assessments/0004-tremor.md