network-observability-operator icon indicating copy to clipboard operation
network-observability-operator copied to clipboard

Published 20 hours ago • verified publisher icon netobserv

Improve asciidocs

Open jpinsonneau opened this issue 1 year ago • 2 comments

Description

  • moved cardinalities and loki labels out of frontend config using separated JSONs
  • get OTEL configs from JSON

Preview: https://github.com/netobserv/network-observability-operator/blob/ascii_docs/docs/flows-format.adoc

Dependencies

n/a

Checklist

If you are not familiar with our processes or don't know what to answer in the list below, let us know in a comment: the maintainers will take care of that.

  • [ ] Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • [ ] Does this PR require product documentation?
    • [ ] If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • [ ] Does this PR require a product release notes entry?
    • [ ] If so, fill in "Release Note Text" in the JIRA.
  • [ ] Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
    • [ ] If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
    • [ ] Standard QE validation, with pre-merge tests unless stated otherwise.
    • [ ] Regression tests only (e.g. refactoring with no user-facing change).
    • [ ] No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

jpinsonneau avatar Oct 08 '24 12:10 jpinsonneau

Skipping CI for Draft Pull Request. If you want CI signal for your change, please convert it to an actual PR. You can still manually trigger a test run with /test all

openshift-ci[bot] avatar Oct 08 '24 12:10 openshift-ci[bot]

marking no-qe as it's only refactoring + doc gen without visible impact in product

jotak avatar Oct 11 '24 08:10 jotak

Thanks for the feedback @jotak If you are ok as is we can merge ;)

jpinsonneau avatar Oct 14 '24 10:10 jpinsonneau

I've opened https://github.com/openshift/openshift-docs/pull/83465 to update the downstream docs. PTAL for approvals over there @jpinsonneau. This one LGTM!

skrthomas avatar Oct 14 '24 19:10 skrthomas

/lgtm /approve

jotak avatar Oct 17 '24 07:10 jotak

[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 /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci[bot] avatar Oct 17 '24 07:10 openshift-ci[bot]