Improve asciidocs #809
Improve asciidocs #809
Conversation
|
Skipping CI for Draft Pull Request. |
hack/asciidoc-flows-gen.sh
Outdated
| echo -e '|===' >> $ADOC | ||
| echo -e '| Name | Type | Description | Filter ID | Loki label | Cardinality' >> $ADOC | ||
| echo -e '| Name | Type | Description | Filter ID | Loki label | Cardinality | Otel' >> $ADOC |
There was a problem hiding this comment.
Since this ends up in the downstream doc we should write the official name and not "otel"
| echo -e '| Name | Type | Description | Filter ID | Loki label | Cardinality | Otel' >> $ADOC | |
| echo -e '| Name | Type | Description | Filter ID | Loki label | Cardinality | OpenTelemetry' >> $ADOC |
There was a problem hiding this comment.
done in 5eecbd5
|
|
||
| //go:embed cardinality.json | ||
| var rawCardinality []byte | ||
| var cardinality *map[string]Warn |
There was a problem hiding this comment.
map is already a reference we don't need a pointer here
There was a problem hiding this comment.
done in 5eecbd5
pkg/helper/otel/otel_config.go
Outdated
| var otelConfig *map[string]string | ||
| var otelRules *[]api.GenericTransformRule |
There was a problem hiding this comment.
same here for slice & map, pointer is unnecessary
There was a problem hiding this comment.
done in 5eecbd5
|
marking no-qe as it's only refactoring + doc gen without visible impact in product |
|
Thanks for the feedback @jotak |
|
I've opened openshift/openshift-docs#83465 to update the downstream docs. PTAL for approvals over there @jpinsonneau. This one LGTM! |
|
/lgtm |
|
[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 |
Description
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.