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

docs: Add "Known issues" page #11608

Merged
merged 4 commits into from
Nov 29, 2023
Merged

Conversation

colleenmcginnis
Copy link
Contributor

Closes #11282

Creates a new "Known issues" page with suggested formatting for listing known issues. There are not currently any known issues listed. I found two existing known issues (8.5.asciidoc and 7.9.asciidoc), but I'm not sure if they still apply to more recent versions. From @simitt:

we'll need to go through a couple of different sources to pull the Known Issues together.

@simitt I'll let you tag others to help identify existing known issues, and then I can help with any necessary copy editing, reformatting once we know what the content will look like, and cross-referencing between release notes and this new page.

@colleenmcginnis colleenmcginnis added docs backport-8.10 Automated backport with mergify labels Sep 7, 2023
@colleenmcginnis colleenmcginnis self-assigned this Sep 7, 2023
@simitt
Copy link
Contributor

simitt commented Sep 15, 2023

@elastic/apm-server please help collecting the Known Issues for 8.10 and main

@kruskall
Copy link
Member

I found two existing known issues (8.5.asciidoc and 7.9.asciidoc), but I'm not sure if they still apply to more recent versions.

From 8.5:

Due to a recent change in the Red Hat scan verification process, this version of APM Server is not available in the Red Hat Ecosystem Catalog. This bug will be fixed in the next release. Please use the Elastic docker registry to download the 8.5.0 APM Server image.

This doesn't seem to be an issue anymore as the images appears in the redhat catalog: https://catalog.redhat.com/software/containers/elastic/apm/5fabf3c0ecb52450895164b5

From 7.9:

APM Server introduced support for cloud metadata in v7.9 ({pull}3729[3729]). Unfortunately, the JSON Schema was too strict, and does not account for null values. As a result, sending null values for cloud metadata causes the payload to be rejected. This issue was resolved in v7.10.0 ({pull}4142[4142]). To avoid problems, we recommend updating to version ≥7.10.0.

This doesn't apply anymore. cloud.instance.metadata and other similar fields are declared as nullable.String so they handle null values correctly.

@simitt
Copy link
Contributor

simitt commented Oct 3, 2023

@carsonip let's start with collecting the Known Issues for 8.11. It's probably best to go through open bugs and reported issues and collect the more impactful issues in these docs.

@colleenmcginnis
Copy link
Contributor Author

👋 @simitt @carsonip have you collected any known issues for 8.11 yet?

@carsonip
Copy link
Member

Sorry I missed the github notification. Yes, we just got a new known issue for 8.11: #12103

@colleenmcginnis colleenmcginnis marked this pull request as ready for review November 27, 2023 18:25
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner November 27, 2023 18:25
@colleenmcginnis
Copy link
Contributor Author

Sorry I missed the github notification. Yes, we just got a new known issue for 8.11: #12103

Thanks @carsonip! Can you take a look at the language and format I used? Here's the preview: Known issues.

Copy link
Contributor

@simitt simitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@simitt simitt enabled auto-merge (squash) November 29, 2023 06:42
@simitt simitt merged commit 667d5fc into elastic:main Nov 29, 2023
9 checks passed
mergify bot pushed a commit that referenced this pull request Nov 29, 2023
(cherry picked from commit 667d5fc)
mergify bot added a commit that referenced this pull request Nov 29, 2023
(cherry picked from commit 667d5fc)

Co-authored-by: Colleen McGinnis <[email protected]>
@carsonip
Copy link
Member

carsonip commented Jan 2, 2024

This seems to be missing backport-8.11, now adding it back.

@carsonip
Copy link
Member

carsonip commented Jan 2, 2024

@Mergifyio backport 8.11

Copy link
Contributor

mergify bot commented Jan 2, 2024

backport 8.11

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Jan 2, 2024
(cherry picked from commit 667d5fc)
mergify bot added a commit that referenced this pull request Jan 2, 2024
(cherry picked from commit 667d5fc)

Co-authored-by: Colleen McGinnis <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.10 Automated backport with mergify docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create Known Issues section in release notes
4 participants