Use bulleted list for resources#186
Merged
Merged
Conversation
Fix markdown with missing bullet points, so it doesn't run the field descriptions across one line when rendered. Signed-off-by: Stephen Lau <stephen@lau.engineering>
mathieu-benoit
requested changes
Jun 3, 2025
Standardize on similar style to `service` and `containers` sections. Co-authored-by: Mathieu Benoit <mathieu-benoit@hotmail.fr> Signed-off-by: Stephen Lau <stephen@lau.engineering>
Signed-off-by: Mathieu Benoit <mathieu-benoit@hotmail.fr>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
What is the motivation?
The docs where hard to read when
type,class,id,paramswhere on one line. Other areas andannotationsuse bullet points so standardize to that.What does this change do?
Fix markdown with missing bullet points, so it doesn't run the field descriptions across one line when rendered.
What is your testing strategy?
Trivial change to docs, didn't test aside from reviewing code.
Is this related to any issues?
No
Have you read the Contributing Guidelines?