Skip to content

(Doc+) Capture Elasticsearch diagnostic#108259

Merged
stefnestor merged 4 commits intoelastic:mainfrom
stefnestor:stef_diag
May 9, 2024
Merged

(Doc+) Capture Elasticsearch diagnostic#108259
stefnestor merged 4 commits intoelastic:mainfrom
stefnestor:stef_diag

Conversation

@stefnestor
Copy link
Copy Markdown
Member

👋 howdy, team! This adds a page under Troubleshooting called "Capturing Diagnostic" to outline for users how to capture an Elasticsearch diagnostic (same as we've done for ECE/ECK products).

@stefnestor stefnestor added >enhancement Team:Docs Meta label for docs team Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. labels May 3, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 3, 2024

Documentation preview:

@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v8.15.0 external-contributor Pull request authored by a developer outside the Elasticsearch team and removed Team:Docs Meta label for docs team labels May 3, 2024
@shainaraskas shainaraskas self-requested a review May 3, 2024 17:35
@stefnestor stefnestor added >docs General docs changes Team:Docs Meta label for docs team labels May 3, 2024
@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label May 3, 2024
@elasticsearchmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@shainaraskas
Copy link
Copy Markdown
Contributor

shainaraskas commented May 8, 2024

Hey Stef! I might have swung the pendulum too far here, but I took a shot at editing your PR and pushed up a commit.

general changes:

  • added the file to the nav
  • chunked up the instructions a bit - left the happy path intact, and split off the "what to do if you get an error" guidance into additional sections
  • general formatting cleanup

Let me know what you think. A preview link should now be created for you to look over (before, it wasn't showing up because the file wasn't added to the nav).

@stefnestor
Copy link
Copy Markdown
Member Author

Your changes are excellent, thanks @shainaraskas 💚 !

@stefnestor stefnestor merged commit 1a55e2f into elastic:main May 9, 2024
shainaraskas added a commit to shainaraskas/elasticsearch that referenced this pull request Jun 21, 2024
* (Doc+) Capture Elasticsearch diagnostic

* add diagnostic topic to nav, chunk content, style edits

* fix test

---------

Co-authored-by: shainaraskas <shaina.raskas@elastic.co>
(cherry picked from commit 1a55e2f)
@shainaraskas
Copy link
Copy Markdown
Contributor

💔 Some backports could not be created

Status Branch Result
8.14
7.17 Conflict resolution was aborted by the user

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 108259

Questions ?

Please refer to the Backport tool documentation

shainaraskas added a commit to shainaraskas/elasticsearch that referenced this pull request Jun 21, 2024
* (Doc+) Capture Elasticsearch diagnostic

* add diagnostic topic to nav, chunk content, style edits

* fix test

---------

Co-authored-by: shainaraskas <shaina.raskas@elastic.co>
(cherry picked from commit 1a55e2f)
elasticsearchmachine pushed a commit that referenced this pull request Jun 21, 2024
* (Doc+) Capture Elasticsearch diagnostic

* add diagnostic topic to nav, chunk content, style edits

* fix test

---------

Co-authored-by: shainaraskas <shaina.raskas@elastic.co>
(cherry picked from commit 1a55e2f)

Co-authored-by: Stef Nestor <26751266+stefnestor@users.noreply.github.com>
elasticsearchmachine pushed a commit that referenced this pull request Jun 21, 2024
* (Doc+) Capture Elasticsearch diagnostic

* add diagnostic topic to nav, chunk content, style edits

* fix test

---------

Co-authored-by: shainaraskas <shaina.raskas@elastic.co>
(cherry picked from commit 1a55e2f)

Co-authored-by: Stef Nestor <26751266+stefnestor@users.noreply.github.com>
@stefnestor stefnestor deleted the stef_diag branch November 15, 2024 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes >enhancement external-contributor Pull request authored by a developer outside the Elasticsearch team Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. Team:Docs Meta label for docs team v8.15.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants