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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Discover][Extension] Document Viewer #184084

Closed
Tracked by #181728
kertal opened this issue May 23, 2024 · 3 comments 路 Fixed by #185940
Closed
Tracked by #181728

[Discover][Extension] Document Viewer #184084

kertal opened this issue May 23, 2024 · 3 comments 路 Fixed by #185940
Assignees
@jughosta
Labels
enhancement New value added to drive a business result Feature:Discover Discover Application impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort Project:OneDiscover Enrich Discover with contextual awareness / Merge with Logs Explorer Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Graph)
Projects
Discover

Comments

@kertal
Copy link
Member

kertal commented May 23, 2024 •
edited

馃摀 Summary

What: The extension point entails creating a custom fly-out interface within the document viewer. This could involve adding functionalities such as better navigation, filtering options, or additional contextual information to enhance the UX when viewing documents.

Why: This improvement is driven by a need to provide users with a contextual and efficient way to view and interact with specific document types.

This is the current, vanilla Document Viewer in Discover

Image

This is the version being used by Log Explorer

Bildschirmfoto 2024-05-23 um 09 24 48

The aim is to provide the extension point configuration that enables this extended version, optimized for logs usage, to be provided by the Contextual awareness architecture, and can be used to extend the Document Viewer for different contexts

鉁旓笍 Acceptance criteria

  • Make the title of the the flyout configureable
  • Implement a way to replace the Document Viewer by a custom flyout to provide support for advanced use cases that can't be covered by the default document viewer
@kertal kertal added the Project:OneDiscover Enrich Discover with contextual awareness / Merge with Logs Explorer label May 23, 2024
@botelastic botelastic bot added the needs-team Issues missing a team label label May 23, 2024
@kertal kertal added the Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Graph) label May 23, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

@botelastic botelastic bot removed the needs-team Issues missing a team label label May 23, 2024
@kibanamachine kibanamachine added this to Inbox in Discover May 23, 2024
@kertal kertal mentioned this issue May 23, 2024
Closed
@davismcphee
Copy link
Contributor

@kertal I discussed this with @jughosta earlier, and I think we can start implementing this extension point now, but I think we should split this task out into a followup issue until we have a clear product need for it:

Implement a way to replace the Document Viewer by a custom flyout to provide support for advanced use cases that can't be covered by the default document viewer

IMO in an ideal situation all Discover profiles would use the same base flyout and customize it as needed, otherwise I feel it will impact consistency and complicate the extension point, making the compositional aspect of the framework harder to manage for this extension point (e.g. can be customized at multiple context levels).

If that works for you, can we switch this from Refining to In Progress and add it to the current iteration for @jughosta to start working on?

@kertal
Copy link
Member Author

kertal commented Jun 5, 2024

Sure works for me, removed this task, added it as a draft to our board, I do agree we need more product details here.

@kertal kertal added the impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. label Jun 5, 2024
@davismcphee davismcphee added loe:small Small Level of Effort Feature:Discover Discover Application enhancement New value added to drive a business result labels Jun 5, 2024
@jughosta jughosta mentioned this issue Jun 11, 2024
Merged
1 task
@kertal kertal mentioned this issue Jun 12, 2024
Open
nikitaindik pushed a commit to nikitaindik/kibana that referenced this issue Jun 18, 2024
@jughosta @nikitaindik
[Discover][Extension] Document Viewer (elastic#185940)
ede2215 
- Closes elastic#184084

## Summary

This PR adds extension points to Doc Viewer flyout:
- `title`
-  `docViewsRegistry`.

Example:
```typescript
profile: {
    getDocViewer: (prev) => (params) => {
      const recordId = params.record.id;
      const prevValue = prev(params);
      return {
        title: `${prevValue.title} #${recordId}`,
        docViewsRegistry: (registry) => {
          registry.enableById('doc_view_logs_overview');
          return prevValue.docViewsRegistry(registry);
        },
      };
    },
  },
```


### Checklist

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jughosta jughosta

Labels
enhancement New value added to drive a business result Feature:Discover Discover Application impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort Project:OneDiscover Enrich Discover with contextual awareness / Merge with Logs Explorer Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Graph)
Projects
No open projects
Discover
Inbox
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Discover][Extension] Document Viewer jughosta/kibana
4 participants
@kertal @jughosta @elasticmachine @davismcphee