Skip to content
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

Update CRD documentation #304

Merged
merged 1 commit into from
Mar 22, 2023
Merged

Conversation

jotak
Copy link
Member

@jotak jotak commented Mar 22, 2023

  • switch asciidoc gen to referencing v1beta1
  • improve doc & default for ignored metrics (those changes were previously done on v1alpha1 instead of v1beta1, mistakenly)
  • add enum info on disableAlerts doc (unfortunately the enum doc, while being correctly picked up for openapi, is not picked up for doc generation; so I am duplicating it)
  • regenerate bundle & doc

- switch asciidoc gen to referencing v1beta1
- improve doc & default for ignored metrics (those changes were previously
  done on v1alpha1 instead of v1beta1, mistakenly)
- add enum info on disableAlerts doc (unfortunately the enum doc, while
  being correctly picked up for openapi, is not picked up for doc
generation; so I am duplicating it)
- regenerate bundle & doc
@jotak jotak added the no-qe This PR doesn't necessitate QE approval label Mar 22, 2023
@jotak
Copy link
Member Author

jotak commented Mar 22, 2023

@skrthomas here's the CRD doc update, with the re-generated asciidoc file

@OlivierCazade I noticed that your PR here did not show the disableAlerts enum documentation .. whereas is works correctly with openapi, it doesn't with our doc generators. So I am duplicating the enum listing & doc so it can appear in doc - it's not ideal for sure ... if we can find another way to have it in doc without duplication, would be better

@codecov
Copy link

codecov bot commented Mar 22, 2023

Codecov Report

Merging #304 (386703b) into main (44e1b37) will decrease coverage by 0.33%.
The diff coverage is 56.71%.

@@            Coverage Diff             @@
##             main     #304      +/-   ##
==========================================
- Coverage   49.66%   49.33%   -0.33%     
==========================================
  Files          43       43              
  Lines        5020     5035      +15     
==========================================
- Hits         2493     2484       -9     
- Misses       2324     2341      +17     
- Partials      203      210       +7     
Flag Coverage Δ
unittests 49.33% <56.71%> (-0.33%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
api/v1alpha1/flowcollector_types.go 100.00% <ø> (ø)
api/v1alpha1/flowcollector_webhook.go 0.00% <0.00%> (ø)
api/v1alpha1/zz_generated.conversion.go 0.27% <0.00%> (ø)
api/v1beta1/flowcollector_types.go 100.00% <ø> (ø)
api/v1beta1/zz_generated.deepcopy.go 42.33% <0.00%> (ø)
controllers/consoleplugin/consoleplugin_objects.go 92.45% <0.00%> (ø)
controllers/constants/constants.go 100.00% <ø> (ø)
pkg/helper/flowcollector.go 61.70% <50.00%> (ø)
controllers/flowlogspipeline/flp_reconciler.go 75.38% <78.57%> (+13.12%) ⬆️
controllers/flowlogspipeline/flp_common_objects.go 84.44% <86.36%> (-0.42%) ⬇️

... and 6 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Contributor

@OlivierCazade OlivierCazade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@skrthomas skrthomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks @jotak !

@jotak
Copy link
Member Author

jotak commented Mar 22, 2023

/approve

@openshift-ci
Copy link

openshift-ci bot commented Mar 22, 2023

[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-merge-robot openshift-merge-robot merged commit 5e2f0ba into netobserv:main Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm no-qe This PR doesn't necessitate QE approval
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants