Skip to content

Conversation

@alexandra5000
Copy link
Contributor

@alexandra5000 alexandra5000 commented Jan 5, 2026

Summary

This PR introduces a new "Troubleshooting" content type with detailed guidelines for creating effective troubleshooting pages in the Elastic documentation. Additionally, a template for troubleshooting pages is added. Updates to the content types index.md file are also made to include the new troubleshooting section.

Closes #115

Generative AI disclosure

To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following:

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used:
Some edits with Claude Sonnet 4.5 using Cursor

@github-actions
Copy link
Contributor

github-actions bot commented Jan 5, 2026

Vale Linting Results

Summary: 1 warning, 2 suggestions found

⚠️ Warnings (1)
File Line Rule Message
contribute-docs/content-types/_snippets/templates/troubleshooting-template.md 137 Elastic.DontUse Don't use 'Just'.
💡 Suggestions (2)
File Line Rule Message
contribute-docs/content-types/_snippets/templates/troubleshooting-template.md 130 Elastic.Wordiness Consider using 'all' instead of 'all of '.
contribute-docs/content-types/troubleshooting.md 23 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

@alexandra5000 alexandra5000 marked this pull request as ready for review January 12, 2026 14:54
@alexandra5000 alexandra5000 requested a review from a team as a code owner January 12, 2026 14:54
@alexandra5000 alexandra5000 requested review from leemthompo and theletterf and removed request for leemthompo and theletterf January 13, 2026 17:06
Copy link
Contributor

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

Yay! First review pass

@shainaraskas
Copy link
Collaborator

was the old guidance mined before this PR was created? lots in there, especially around error messages

https://stunning-adventure-qrvr1k2.pages.github.io/content-types/troubleshooting/type-troubleshooting/

@alexandra5000
Copy link
Contributor Author

@shainaraskas Thanks! I made some updates based on the old guide.

Copy link
Contributor

@KOTungseth KOTungseth 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 a strong foundation with clear intent, well aligned with how Elastic users consume troubleshooting content, and appropriately prescriptive.

I left some suggestions for making the content more operational for contributors.

@leemthompo
Copy link
Contributor

This looks great! Nice work @alexandra5000, I'm no troubleshooting expert so I'm not really qualified to approve this, but I think with @theletterf and @KOTungseth's suggestions this will be in good shape

@shainaraskas
Copy link
Collaborator

fwiw, support was VERY passionate about us having this additional resources/contact/working with support boilerplate on entrypoints, especially because half of our troubleshooting content is in the support portal

https://stunning-adventure-qrvr1k2.pages.github.io/content-types/troubleshooting/

@alexandra5000
Copy link
Contributor Author

@shainaraskas Very good point, thank you for reminding me about it. I even discussed adding a dedicated "Contact support" page to every troubleshooting folder/section. As of today, a dedicated page exists in some of them, so I included that info as well.

@alexandra5000 alexandra5000 enabled auto-merge (squash) January 20, 2026 16:52
@alexandra5000 alexandra5000 merged commit 0e77e5f into elastic:main Jan 20, 2026
7 of 8 checks passed
@alexandra5000 alexandra5000 deleted the troubleshooting-template branch January 20, 2026 16:55
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.

5 participants