Skip to content

Formalize "known issues" docs concept #111024

@DaveCTurner

Description

@DaveCTurner

Today if we want to call out a known issue in a released version we just add a new ad-hoc item to the release notes of all affected versions. This is kind of a pain, and it's easy to miss versions or for the notes to end up inconsistent across branches/backports etc. See for instance the docs fixes in #111014.

Could we instead introduce a more formal entity to represent each known issue, perhaps something like the file-per-PR changelog structure, to make it harder to make mistakes or miss copying the known issue docs to all the right places?

Metadata

Metadata

Assignees

Labels

:Delivery/ToolingDeveloper tooliing and automation>docsGeneral docs changesTeam:DeliveryMeta label for Delivery teamTeam:DocsMeta label for docs team

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions