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

Improve handling of known issues #632

Merged
merged 1 commit into from
Nov 16, 2020

Conversation

serathius
Copy link
Contributor

  • Extract known issues to separate file KNOWN_ISSUES.md
  • Describe case of missing pod metrics
  • Copy issue template header to bug reports to encaurage people to read existing documentation.

/cc @s-urbaniak

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 9, 2020
KNOWN_ISSUES.md Outdated Show resolved Hide resolved
Copy link
Member

@dgrisonnet dgrisonnet left a comment

Choose a reason for hiding this comment

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

Really nice!

KNOWN_ISSUES.md Outdated Show resolved Hide resolved
@@ -0,0 +1,117 @@
# Known issues

Copy link
Member

Choose a reason for hiding this comment

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

what do you think about adding a TOC here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this is good idea for both KNOWN_ISSUES.md and FAQ.md
To maintain TOC up to date we should have update and validate scripts, so I would propose to do this as a follow up

Copy link
Member

Choose a reason for hiding this comment

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

sgtm 👍

KNOWN_ISSUES.md Outdated Show resolved Hide resolved
KNOWN_ISSUES.md Outdated Show resolved Hide resolved

Workaround: upgrade Docker to 1.19+

## Incorrectly configured front-proxy certificate
Copy link
Member

Choose a reason for hiding this comment

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

I found that the previous formatting made the text more readable, what do you think about applying it to all the issues?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

By previous do you mean:

  • formatting above
  • formatting before this PR
    ?

Copy link
Member

Choose a reason for hiding this comment

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

I meant the formatting above

* Extract known issues to separate file KNOWN_ISSUES.md
* Describe case of missing pod metrics
* Copy issue template header to bug reports to encaurage people to read existing documentation.

Co-authored-by: Damien Grisonnet <[email protected]>
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dgrisonnet, serathius

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

@s-urbaniak
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 16, 2020
@k8s-ci-robot k8s-ci-robot merged commit b87c6e5 into kubernetes-sigs:master Nov 16, 2020
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants