Skip to content

[Discover] Documentation on context awareness #1739

@florent-leborgne

Description

@florent-leborgne

Context

Discover is becoming context aware, meaning that based on the user's data, Discover will provide a tailored experience.

That context-aware experience are called "profiles", at least internally. Each profile is triggered by specific signals in the data, and leads to variations of the Discover UX.

For example, as compared to the default Discover experience, the "Logs" profile will show a status column by default in the data grid, the "Traces" profile includes the ability to expand entries and get a waterfall view of traces, etc.

A few profiles already exist today, and some more are planned in the future.

Goals

This issue has 2 goals:

  • Add documentation to introduce context awareness and describe the existing profiles (and how they differ from the default experience). From Davis: The actual experiences we're supporting in discover today are these:
    • logs
    • traces
    • metrics
    • security (this one is pretty basic so far though, it should change more in the future)
  • Revise the structure and strategy of Discover-related docs (in Explore & Analyze, in solution docs...) and define a possible base template to ease the understanding, linking, and documentation of existing and future profiles.

To consider on top of completing sub-issues

  • Improve linking between related docs
  • Extract a template to facilitate future profile docs

Note for "templated" docs: we've recently seen SEO issues for pages with identical structures and headings. In these cases, it's ok to repeat the profile's name in the various headings.

Contacts

Sub-issues

Metadata

Metadata

Labels

Team:ExperienceIssues owned by the Experience Docs Team

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions