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

Bug 1957889: Improves documentation of GatherClusterOperatorPodsAndEvents #420

Conversation

jholecek-rh
Copy link
Contributor

This PR improves documentation of GatherClusterOperatorPodsAndEvents:

  • Improves wording to make it clear what is collected and when.
  • Lists locations of individual data points so that users know where to
    look for the data even if they don't have a sample archive with the
    data (e.g. when starting an extraction notebook).

Categories

  • Bugfix
  • Enhancement
  • Backporting
  • Others (CI, Infrastructure, Documentation)

Sample archive

N/A

Documentation

I need your help here. Is it preferred to update gathered-data.md with this type of changes or you do it once in a while? I didn't include an updated version of gathered-data.md because it included changes that I didn't do...

Unit Tests

N/A

Privacy

Yes. There are no sensitive data in the newly collected information.

Changelog

No.

References

https://coreos.slack.com/archives/CLABA9CHY/p1620223118250600?thread_ts=1620212876.245500&cid=CLABA9CHY

- Improves wording to make it clear what is collected and when.
- Lists locations of individual data points so that users know where to
  look for the data even if they don't have a sample archive with the
  data (e.g. when starting an extraction notebook).
@tremes
Copy link
Contributor

tremes commented May 6, 2021

@jholecek-rh Thanks!

@tremes
Copy link
Contributor

tremes commented May 6, 2021

/lgtm

@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jholecek-rh, tremes

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-robot openshift-ci-robot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels May 6, 2021
@jholecek-rh
Copy link
Contributor Author

/retest

@jholecek-rh jholecek-rh changed the title Improves documentation of GatherClusterOperatorPodsAndEvents Bug 1957889: Improves documentation of GatherClusterOperatorPodsAndEvents May 6, 2021
@openshift-ci openshift-ci bot added bugzilla/severity-low Referenced Bugzilla bug's severity is low for the branch this PR is targeting. bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. labels May 6, 2021
@openshift-ci
Copy link

openshift-ci bot commented May 6, 2021

@jholecek-rh: This pull request references Bugzilla bug 1957889, which is invalid:

  • expected the bug to target the "4.8.0" release, but it targets "---" instead

Comment /bugzilla refresh to re-evaluate validity if changes to the Bugzilla bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

Bug 1957889: Improves documentation of GatherClusterOperatorPodsAndEvents

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/test-infra repository.

@jholecek-rh
Copy link
Contributor Author

/bugzilla refresh

@openshift-ci
Copy link

openshift-ci bot commented May 6, 2021

@jholecek-rh: This pull request references Bugzilla bug 1957889, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.8.0) matches configured target release for branch (4.8.0)
  • bug is in the state NEW, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @psimovec

In response to this:

/bugzilla refresh

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/test-infra repository.

@openshift-ci openshift-ci bot added bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. and removed bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. labels May 6, 2021
@openshift-merge-robot openshift-merge-robot merged commit 4df6a76 into openshift:master May 6, 2021
@openshift-ci
Copy link

openshift-ci bot commented May 6, 2021

@jholecek-rh: All pull requests linked via external trackers have merged:

Bugzilla bug 1957889 has been moved to the MODIFIED state.

In response to this:

Bug 1957889: Improves documentation of GatherClusterOperatorPodsAndEvents

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/test-infra repository.

@jholecek-rh jholecek-rh deleted the co_pods_gatherer_docs_improvement branch May 6, 2021 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. bugzilla/severity-low Referenced Bugzilla bug's severity is low for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants