-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CRD doc updates #364
CRD doc updates #364
Conversation
jotak
commented
Jun 6, 2023
- clarify "deprecated" and "unsupported" features
- fix/remove a forgotten mention that kafka export is experimental
- reformulate the API description (it also appears on the CSV/operator description)
- a couple of minor fixes
- regenerate docs, update asciidoc
- clarify "deprecated" and "unsupported" features - fix/remove a forgotten mention that kafka export is experimental - reformulate the API description (it also appears on the CSV/operator description) - a couple of minor fixes - regenerate docs, update asciidoc
FYI I've updated the text of the API description, that is also visible when installing / configuring the operator: I find the old text not very good: it's repetitive and doesn't really says anything. I'm proposing this instead:
Also I'm including an explanation of what means "unsupported" etc. |
@skrthomas it includes the re-generation of the asciidoc api reference |
Codecov Report
@@ Coverage Diff @@
## main #364 +/- ##
=======================================
Coverage 53.53% 53.53%
=======================================
Files 45 45
Lines 5329 5329
=======================================
Hits 2853 2853
Misses 2272 2272
Partials 204 204
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/label qe-approved
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jotak 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
@@ -845,7 +900,7 @@ Type:: | |||
|
|||
| `authToken` | |||
| `string` | |||
| AuthToken describe the way to get a token to authenticate to Loki. DISABLED will not send any token with the request. HOST will use the local pod service account to authenticate to Loki. FORWARD will forward user token, in this mode, pod that are not receiving user request like the processor will use the local pod service account. Similar to HOST mode. When using the Loki Operator, set it to `HOST` or `FORWARD`. | |||
| AuthToken describe the way to get a token to authenticate to Loki. DISABLED will not send any token with the request. HOST - _deprecated (*)_ - will use the local pod service account to authenticate to Loki. FORWARD will forward the user token for authorization. When using the Loki Operator, this should be set to `FORWARD`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really minor thing, but IBM Style Guide says to use "must" instead of "should", so is it OK to change this one small thing in the docs version of this 😬 ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@skrthomas I'll send a new PR with this + a couple of other changes