Skip to content

Conversation

marciw
Copy link
Contributor

@marciw marciw commented Dec 4, 2024

Preview

Revise to match new troubleshooting guidelines, mostly to create an example to link to from the guidelines.

  • Restructure and add new elements to reflect the new symptom ref content type
  • Edit generally for conciseness and clarity

Still under discussion: "symptom" sections

Copy link
Contributor

github-actions bot commented Dec 4, 2024

Documentation preview:

@marciw marciw marked this pull request as ready for review December 4, 2024 22:03
@marciw marciw requested a review from shainaraskas December 4, 2024 22:04
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Dec 4, 2024
@marciw marciw added >docs General docs changes Team:Docs Meta label for docs team labels Dec 4, 2024
@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Dec 4, 2024
@elasticsearchmachine
Copy link
Collaborator

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

Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

thanks for taking on this first edit!!

some thinkies for you

task queue.
*******************************
*Product:* Elasticsearch +
*Deployment type:* Elastic Cloud (hosted or self-managed), self-managed +
Copy link
Contributor

Choose a reason for hiding this comment

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

one thing that is tricky w/ elastic cloud is "Elastic Cloud" products like ECE and ECK behave wildly differently, and we also don't consistently understand Elastic Cloud as an umbrella term. here, "Elastic Cloud" just means serverless + hosted, for example. My impulse is to be hyper-specific until we can better define "Elastic Cloud" as any product that has EC in its name or as anything that lives on "Elastic-managed cloud". that's a long way of saying: consider exploding the EC list

Copy link
Contributor

Choose a reason for hiding this comment

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

given that this tutorial uses cat thread pool apis it's def not for serverless ... but probably for everything else

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wonder whether there's a case for just saying "All types except serverless" -- seems like that might be the case often enough?

Copy link
Contributor

Choose a reason for hiding this comment

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

:2c: until we clean up our usage of elastic cloud it's better to be specific (to help later contributors)

Copy link
Contributor

Choose a reason for hiding this comment

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

(or do me a favor and add it as a comment)

Copy link
Contributor Author

@marciw marciw Dec 12, 2024

Choose a reason for hiding this comment

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

Attempted this. Wonder if we need a canonical list in our guidance/template? (and maybe later some sort of fancy standard table with checkmarks, but later)

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah I think we need to see how some conversations around that official messaging goes - but agree we should be able to link to a source of truth. afraid of putting this list together now because it is actively being discussed

@marciw
Copy link
Contributor Author

marciw commented Dec 12, 2024

@shainaraskas TY for the thorough review! I think I've addressed (or skirted) all of your suggestions... at least to the point of "good enough for the purposes of an example"? 🤔

Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

beautiful and delightful to behold! some baby cosmetic thingies, then I think we're ready to link to it in the guidance

@marciw marciw merged commit 696ee80 into elastic:main Dec 19, 2024
5 checks passed
@marciw marciw deleted the mw-symptom-ref branch December 19, 2024 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes Team:Docs Meta label for docs team v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants