helm-charts icon indicating copy to clipboard operation
helm-charts copied to clipboard

Published 20 hours ago • verified publisher icon redpanda-data

Start documenting known issues

Open chrisseto opened this issue 1 year ago • 3 comments
trafficstars

We don't currently have a knowledge base containing known issues or limitations. This can result in duplicated issues, confusion, and frustration for our end users.

The current proposal is to maintain known issues/limitations in github issues using a special label and then having a script that aggregates them and attaches links to our releases notes. It seems that github's gh CLI would make this fairly easy to do.

JIRA Link: K8S-158

chrisseto avatar Apr 17 '24 15:04 chrisseto

Here's an example of a great known issue/limitation candidate: https://github.com/redpanda-data/helm-charts/issues/1173

chrisseto avatar Apr 17 '24 15:04 chrisseto

Redpanda core labels GitHub issues with the Known issue label. It would be nice if we followed the same approach. For example: https://github.com/redpanda-data/redpanda/issues?q=is%3Aopen+is%3Aissue+label%3Aknown-issue

Also, known issues are documented internally in Confluence. I'm not sure if we want to publicize those: https://redpandadata.atlassian.net/wiki/spaces/CORE/pages/223412266/Known+Issues+in+Redpanda+Core

JakeSCahill avatar Apr 24 '24 09:04 JakeSCahill

I like known-issue! We can even use the same color. Though we should probably document somewhere what it means.

chrisseto avatar May 02 '24 14:05 chrisseto