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

Update Logs Explorer docs with new summary column #4468

Merged
merged 4 commits into from
Nov 6, 2024

Conversation

mdbirnstiehl
Copy link
Contributor

Description

Adding the summary column removed the smart fields (except the actions smart field). I've removed the smart fields info from the docs. If we decided to cover the summary column, it should probably be in the discover docs as it applies to both Logs Explorer and Discover and we already defer to the Discover docs for most of the documents table.

I've also updated the screenshots to show the summary column.

Documentation sets edited in this PR

Check all that apply.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #4317

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

@mdbirnstiehl mdbirnstiehl added ci:doc-build backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify labels Nov 1, 2024
@mdbirnstiehl mdbirnstiehl self-assigned this Nov 1, 2024
@mdbirnstiehl mdbirnstiehl requested a review from a team as a code owner November 1, 2024 18:42
Copy link
Contributor

github-actions bot commented Nov 1, 2024

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.

@elasticdocs

This comment was marked as outdated.

tonyghiani
tonyghiani previously approved these changes Nov 5, 2024
Copy link

@tonyghiani tonyghiani 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 updating the screenshots. I agree we should probably document the summary column on the Discover side 👌

This comment was marked as outdated.

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

👍 After seeing the context in this doc, agreed on the doc'ing that on the Discover side

Also, gonna need to change that serverless port to asciidoc as I'm sure you're aware. I could approve this, but as you know it would just be dismissed on your next commit. I will be standing by to approve when you are ready 🖖

@mdbirnstiehl mdbirnstiehl merged commit bc7c5be into elastic:main Nov 6, 2024
4 checks passed
mergify bot pushed a commit that referenced this pull request Nov 6, 2024
(cherry picked from commit bc7c5be)

# Conflicts:
#	docs/en/serverless/images/log-explorer.png
#	docs/en/serverless/images/log-menu.png
#	docs/en/serverless/logging/view-and-monitor-logs.asciidoc
mergify bot pushed a commit that referenced this pull request Nov 6, 2024
(cherry picked from commit bc7c5be)

# Conflicts:
#	docs/en/serverless/images/log-explorer.png
#	docs/en/serverless/images/log-menu.png
#	docs/en/serverless/logging/view-and-monitor-logs.asciidoc
mdbirnstiehl pushed a commit that referenced this pull request Nov 6, 2024
…mn (#4490)

* Update Logs Explorer docs with new summary column (#4468)
mdbirnstiehl pushed a commit that referenced this pull request Nov 6, 2024
…umn (#4489)

* Update Logs Explorer docs with new summary column (#4468)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Logs] Document the summary column
5 participants