doc: fix layout of OperatorHub doc #171
Conversation
| // * Deep Insights | ||
| // | ||
| // * Auto Pilot | ||
| // |
There was a problem hiding this comment.
+1 on this added spacing since it helps separate "capabilities" above and the "categories" below.
There was a problem hiding this comment.
I am not sure if it's just me but adding all these extra spacings makes me feel it's a bit harder to read through the comments.
I do like some extra spacings to better separate the zoning though. So perhaps the rule could be we add spacings between every - but no extra spacings between * so things are that not wide spread but still provides some zoning?
What do you think?
|
Hi @tlwu2013,
The changes here are required to fix the layout for its docs to be generated properly. We ought to not ask for a look in the code and instead provide the link: https://pkg.go.dev/github.com/operator-framework/api@master/pkg/validation/internal#OperatorHubValidator
The spaces are to allow breaking the lines in the golang docs generated for the API. adopted - instead of * will not solve this need. |
|
thanks for the clarification, sgtm @camilamacedo86 |
| // * "Basic Install" | ||
| // * "Seamless Upgrades" | ||
| // * "Full Lifecycle" | ||
| // * "Deep Insights" | ||
| // * "Auto Pilot" |
There was a problem hiding this comment.
indentation also works for correcting the output formatting
// - The annotations capabilities into the CSV has a valid option, which are:
// * "Basic Install"
// * "Seamless Upgrades"
// * "Full Lifecycle"
// * "Deep Insights"
// * "Auto Pilot"
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, kevinrizza The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
Signed-off-by: Per G. da Silva <[email protected]>
Signed-off-by: Per G. da Silva <[email protected]>
Description
Just fix the layout for the doc: https://pkg.go.dev/github.com/operator-framework/api@master/pkg/validation/internal#OperatorHubValidator