-
Notifications
You must be signed in to change notification settings - Fork 162
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
Add topic about missing fields #4183
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
|
@roshan-elastic This PR is ready for review as soon as the doc build completes. Let me know what you think of the title. I wanted to make it easy for users to map what they see in the UI to the topic title here, but not sure if it works completely. I also wanted to provide some actionable guidance rather than just explaining the situations where this message appears. Let me know what you think! |
Hey @dedemorton thanks for writing this up. Here are my thoughts:
I hear your point on actionable guidance. I think the tricky thing is that action may/may not be needed. Maybe we could be a bit softer and make it more informative? I like the way you provide action points where it might be more something you want to fix (e.g. you've chosen not to collect it): Understanding 'No results found' message Docs hierarchy It feels like this might be a bit too prevalent and I'm wondering whether it makes sense to nest this under some kind of a 'Troubleshooting' section? Not sure this is the best solution but it feels a bit granular to be at the same level as the other major topics in the nav. Any thoughts? Note : We can easily redirect the UI link to the docs via the short-link we're using (https://ela.st/hosts-missing-fields) |
I totally agree. The topic is a weird outlier in the hierarchy. In general, I hesitate to add a container that only has a single topic, but I think I can add some useful info to the container topic that makes it worthwhile, so I'll give it a shot. |
@roshan-elastic I've added the troubleshooting section as you requested. I reused some text that we have elsewhere to put some useful detail in the topic. I'm assuming someone must have worked with support on the wording for that page, but I'm not sure. Check out the preview as soon as the build is done and let me know what you think. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for doing this!
Oh actually @dedemorton - just checked out the actual troubleshooting page. I think this is OK to go live - I'm wondering if it's worth putting in links to the 'child' docs on the page too (so you don't have to look at the LHN to see the child docs)? |
I think it's a good idea to do this. It's always a little weird to add a hierarchy or bulleted list that has one item. Typically I would put a singleton topic as a section in the main troubleshooting topic until we have more content, but since we are pointing to this page directly from the UI, I think it's better to have a dedicated page. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small change for consistency with our OTel docs.
Co-authored-by: Mike Birnstiehl <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
Cheers @dedemorton @mdbirnstiehl, This is awesome - users now understand why there are missing fields in our UI :) FYI @teresaalvarezsoler - thought you might like this! |
Closes #4091
Preview link: https://observability-docs_bk_4183.docs-preview.app.elstc.co/guide/en/observability/master/handle-no-results-found-message.html
TODO after merging: