Skip to content
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

Merged
merged 4 commits into from
Aug 28, 2024
Merged

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Aug 21, 2024

@dedemorton dedemorton self-assigned this Aug 21, 2024
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

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.

Copy link
Contributor

mergify bot commented Aug 21, 2024

This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Aug 21, 2024
@dedemorton dedemorton marked this pull request as ready for review August 21, 2024 21:57
@dedemorton dedemorton requested a review from a team as a code owner August 21, 2024 21:57
@dedemorton
Copy link
Contributor Author

@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!

@roshan-elastic
Copy link
Contributor

Hey @dedemorton thanks for writing this up. Here are my thoughts:

Let me know what you think of the title

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

image

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?

image

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)

@dedemorton
Copy link
Contributor Author

dedemorton commented Aug 22, 2024

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.

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.

@dedemorton
Copy link
Contributor Author

@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!

roshan-elastic
roshan-elastic previously approved these changes Aug 27, 2024
Copy link
Contributor

@roshan-elastic roshan-elastic left a 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!

@roshan-elastic
Copy link
Contributor

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)?

@dedemorton
Copy link
Contributor Author

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.

Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a 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.

Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

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

🚀

@dedemorton dedemorton merged commit a311710 into elastic:main Aug 28, 2024
4 checks passed
@dedemorton dedemorton deleted the issue#4091 branch August 28, 2024 17:45
dedemorton added a commit to dedemorton/observability-docs that referenced this pull request Aug 29, 2024
dedemorton added a commit to dedemorton/observability-docs that referenced this pull request Aug 29, 2024
dedemorton added a commit that referenced this pull request Aug 30, 2024
@roshan-elastic
Copy link
Contributor

Cheers @dedemorton @mdbirnstiehl,

This is awesome - users now understand why there are missing fields in our UI :)

FYI @teresaalvarezsoler - thought you might like this!

missing fields

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request]: 'Missing Field' explanation for Host documentation
3 participants