Skip to content

Add KnownIssues.md (packages-specific) #68

Description

@lockwobr

Part of #54.

Summary

Add a KnownIssues.md at the repo root: a running list of known issues with workarounds, recreation steps, and fixes when available. nodewright has one (KnownIssues.md); this repo does not, and SUPPORT.md (see the SUPPORT issue) links to it.

Adaptation required (content is net-new, not a port)

nodewright's known-issues are operator-specific (uninstall/image-pull behavior). Do not port that content. Seed this file with known issues specific to the packages here (per-package quirks, version-specific gotchas, workarounds), or start it as a documented-empty template if there are none to record yet.

Format per entry (from nodewright):

  • A ## <version or package>: <short title> heading
  • Problem
  • How to recreate
  • Temporary workaround
  • Potential fix
  • Strike through and mark fixed entries with the release that resolved them.

Acceptance

  • KnownIssues.md exists at the root in the documented format, seeded with current known issues (or an explicit "none currently known" note).
  • The SUPPORT.md link to it resolves.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docDocumentation addition, correction, or improvement

    Type

    Fields

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions