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

Netobserv API doc regeneration #76593

Merged
merged 1 commit into from
Jun 11, 2024

Conversation

skrthomas
Copy link
Contributor

@skrthomas skrthomas commented May 28, 2024

Version(s):

Merge to only the no-1.6 branch - no cherrypicks are required.
This PR is part of an experiment for simplifying merges for asynchronous content, and I will open one PR against main to incorporate all of the Network Observability 1.6 content just before its GA
Issue:

Link to docs preview:

https://76593--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/flowcollector-api.html

QE review:

  • QE has approved this change.

Additional information:

Notes to peer reviewers:

  • There are about 9 (I think) instances of spec...advanced.scheduling that contain the same specs for tolerations, priorityClassName, nodeSelector, and affinity. After you look at one, feel free to glaze over the others :)
  • There are some minor deprecation updates. If you ctrl+f for "deprecated" you should be able to see those changes.

@openshift-ci openshift-ci bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 28, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented May 28, 2024

@skrthomas skrthomas requested review from memodi and jotak May 29, 2024 19:45
@skrthomas
Copy link
Contributor Author

@memodi @jotak can you PTAL at this PR for API doc regeneration? Joel, I left some review feedback in your PR: netobserv/network-observability-operator#657 (review). So I guess once that's incorporated, I'll copy it over here. It was mostly minor copy edits, things like capitalization and backticks.

Copy link

@memodi memodi left a comment

Choose a reason for hiding this comment

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

looks good overall, just one comment.

@skrthomas skrthomas force-pushed the netobserv-api-regen branch from 45317dc to 03336dc Compare June 4, 2024 01:06
@aireilly
Copy link
Contributor

aireilly commented Jun 4, 2024

/retest

@skrthomas skrthomas force-pushed the netobserv-api-regen branch from 03336dc to 85ec798 Compare June 4, 2024 19:10
@skrthomas skrthomas added the peer-review-needed Signifies that the peer review team needs to review this PR label Jun 4, 2024
@kcarmichael08 kcarmichael08 added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jun 5, 2024
Copy link
Contributor

@kcarmichael08 kcarmichael08 left a comment

Choose a reason for hiding this comment

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

I realized that some of the things I commented on were previously accepted text, so I think it's OK to ignore those comments. (I stopped after I realized, about halfway in.) But I think that the link: issue might need to be fixed, just in case it might cause issues in rendering. Also I've been told that blank/empty lines can cause issues, although they seem to be fine in the preview.

@kcarmichael08 kcarmichael08 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jun 5, 2024
@skrthomas
Copy link
Contributor Author

@kcarmichael08 thanks for the review. I know this is a lot to get through. @jotak do you want to take this feedback upstream with the FlowMetric updates now? Or otherwise, as I said in SCRUM, I can open a Jira to fix these next regeneration.

@jotak
Copy link

jotak commented Jun 7, 2024

thanks @kcarmichael08 - almost everything should be addressed upstream in netobserv/network-observability-operator#672 - except a few things which I commented here.

@skrthomas skrthomas force-pushed the netobserv-api-regen branch from 28bfcd2 to 42deab0 Compare June 10, 2024 20:53
Copy link

openshift-ci bot commented Jun 10, 2024

@skrthomas: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Copy link

@jotak jotak left a comment

Choose a reason for hiding this comment

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

thanks @skrthomas !

Copy link

@memodi memodi left a comment

Choose a reason for hiding this comment

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

/label qe-approved

@openshift-ci openshift-ci bot added the qe-approved Signifies that QE has signed off on this PR label Jun 11, 2024
@skrthomas skrthomas merged commit 190d2ae into openshift:no-1.6 Jun 11, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
peer-review-done Signifies that the peer review team has reviewed this PR qe-approved Signifies that QE has signed off on this PR size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants