Update downstream CSV description to link to official doc #397
Conversation
jotak
requested review from
msherif1234,
OlivierCazade,
nathan-weinberg,
skrthomas and
memodi
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Codecov Report
@@ Coverage Diff @@
## main #397 +/- ##
==========================================
- Coverage 54.52% 53.67% -0.85%
==========================================
Files 44 44
Lines 5423 5559 +136
==========================================
+ Hits 2957 2984 +27
- Misses 2259 2359 +100
- Partials 207 216 +9
Flags with carried forward coverage won't be shown. Click here to find out more. |
config/descriptions/ocp.md
Outdated
| @@ -8,13 +8,9 @@ The operator provides dashboards, metrics, and keeps flows accessible in a query | |||
|
|
|||
| [Loki](https://grafana.com/oss/loki/), from GrafanaLabs, is the backend that is used to store all collected flows. The NetObserv Operator does not install Loki directly, however we provide some guidance to help you there. | |||
|
|
|||
| For normal usage, we recommend two options: | |||
| - For a persistent usage, refer to [the operator documentation](https://docs.openshift.com/container-platform/latest/networking/network_observability/installing-operators.html). | |||
There was a problem hiding this comment.
| - For a persistent usage, refer to [the operator documentation](https://docs.openshift.com/container-platform/latest/networking/network_observability/installing-operators.html). | |
| - For production usage, refer to [the operator documentation](https://docs.openshift.com/container-platform/latest/networking/network_observability/installing-operators.html). |
There was a problem hiding this comment.
ok - I was thinking it's more than "production", for instance a persistent staging environment should also refer to the doc - any other thoughts then?
There was a problem hiding this comment.
Hmmm perhaps "a production or production-like test environment" ?
There was a problem hiding this comment.
@skrthomas , wdyt, sounds good to you?
There was a problem hiding this comment.
That suggestion is good with me!
|
New changes are detected. LGTM label has been removed. |
|
thanks @nathan-weinberg @skrthomas - I updated with your suggestion .. and also found another outdated stuff regarding exporters, still mentioned as experimental |
Co-authored-by: Sara Thomas <sarthoma@redhat.com>
jotak
force-pushed
the
downstream-csv-doc
branch
from
b371291
to
035423e
Compare
This is a small update to the CSV description used for downstream, that we should probably have done already earlier: removes the mentions of our unofficial guides, replaced with a link to the official doc