Skip to content

[DOCS] Opster Migration: Add errors to troubleshooting pages #1116

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

Merged
merged 18 commits into from
Apr 23, 2025

Conversation

thekofimensah
Copy link
Contributor

  • Created a new Errors section in troubleshooting with specific errors inside
  • Added to security troubleshooting 2 errors, attempting to follow existing formatting

Attempted to follow https://docs.elastic.dev/content-architecture/content-type/troubleshooting/error

Via discussion with @marciw , this section is still being organized so these may be moved around.

@marciw
Copy link
Contributor

marciw commented Apr 14, 2025

thanks @thekofimensah ! I'll review soon, FYI but these won't be for 9.0 because we don't want to inadvertently introduce build issues right before the release.

also there are 92 build errors (?!) so we'll have to figure out what's up there ;)

@marciw marciw self-requested a review April 14, 2025 12:52
@marciw marciw removed their assignment Apr 14, 2025
@marciw marciw requested a review from Copilot April 14, 2025 12:56
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (4)

troubleshoot/elasticsearch/unable-to-retrieve-node-fs-stats.md:10

  • [nitpick] Consider removing or clarifying the placeholder comment to ensure the documentation is clear and professional.
# is mapped_pages needed for newly created docs?

troubleshoot/elasticsearch/security/token-expired.md:10

  • [nitpick] Review whether the placeholder comment is necessary; if not, it could be removed to streamline the document.
# is mapped_pages needed for newly created docs?

troubleshoot/elasticsearch/security/invalid-token.md:10

  • [nitpick] Consider removing the placeholder comment if it is not intended for the final documentation.
# is mapped_pages needed for newly created docs?

troubleshoot/elasticsearch/failed-to-parse-field-of-type.md:10

  • [nitpick] Evaluate whether this placeholder comment should be removed to avoid potential confusion in the final documentation.
# is mapped_pages needed for newly created docs?

@marciw
Copy link
Contributor

marciw commented Apr 14, 2025

also there are 92 build errors (?!) so we'll have to figure out what's up there ;)

I merged in 'main' to fix these. review coming soon ⏳

Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

This is just a first batch of comments -- more coming soon.

Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

Still not done, but sending over another batch of suggestions

@marciw
Copy link
Contributor

marciw commented Apr 21, 2025

btw @thekofimensah , just want to make sure you're aware that every docs PR automatically gets a preview link: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1116/troubleshoot/elasticsearch/ (look for environments/deployments in the PR history)

This can help with things like figuring out whether to use bash or console

Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

Another batch

marciw and others added 4 commits April 21, 2025 18:37
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

Last batch for now. Thanks for working through all my suggestions!

thekofimensah and others added 3 commits April 23, 2025 10:54
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

A few more tweaks.

Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

Approving but w/ one more grammar note. Thanks!

@marciw marciw merged commit 2ad7177 into main Apr 23, 2025
4 checks passed
@marciw marciw deleted the kofi-troubleshooting-docs-bulk branch April 23, 2025 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants