-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Conversation
47dd20c
to
6b592cb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice!
@@ -0,0 +1,117 @@ | |||
# Known issues | |||
|
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sgtm 👍
|
||
Workaround: upgrade Docker to 1.19+ | ||
|
||
## Incorrectly configured front-proxy certificate |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
?
There was a problem hiding this comment.
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]>
2664e43
to
076cb8b
Compare
[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 |
/lgtm |
/cc @s-urbaniak