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

Create Known Issues section in release notes #11282

Closed
simitt opened this issue Jul 25, 2023 · 2 comments · Fixed by #11608
Closed

Create Known Issues section in release notes #11282

simitt opened this issue Jul 25, 2023 · 2 comments · Fixed by #11608
Assignees
Labels
docs Team:Docs Label for the Observability docs team
Milestone

Comments

@simitt
Copy link
Contributor

simitt commented Jul 25, 2023

Create a dedicated section Known Issues in apm-server docs. The goal is that all known issues from a specific version are easily searchable and users can get a good overview before upgrading to a certain version.

The discussed approach is as follows:

  • have one common asciidoc where known issues are collected
  • per release note version, pull in the existing known issues from the common file
@simitt simitt added docs Team:Docs Label for the Observability docs team labels Jul 25, 2023
@simitt simitt added this to the 8.10 milestone Jul 25, 2023
@colleenmcginnis
Copy link
Contributor

colleenmcginnis commented Sep 7, 2023

👋 @simitt are there existing known issues documented elsewhere that I can pull from or should a create an empty page for now that the team can add to as needed?

Edit: I just see two in the changelog files: 8.5.asciidoc and 7.9.asciidoc.

@simitt
Copy link
Contributor Author

simitt commented Sep 7, 2023

An empty page to start with sounds good; I think we'll need to go through a couple of different sources to pull the Known Issues together.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Team:Docs Label for the Observability docs team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants