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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Explorer] Remove Discover links from log explorer document fly-out #165217

Closed
weltenwort opened this issue Aug 30, 2023 · 1 comment · Fixed by #166638
Closed

[Explorer] Remove Discover links from log explorer document fly-out #165217

weltenwort opened this issue Aug 30, 2023 · 1 comment · Fixed by #166638
Assignees
@tonyghiani
Labels
Feature:LogsExplorer Logs Explorer feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v8.11.0

Comments

@weltenwort
Copy link
Member

weltenwort commented Aug 30, 2023 •
edited

📓 Summary

There are a few hard-coded links in the document fly-out that the log explorer automatically inherits from the discover main app. We want to remove these links for now with the option of placing observability-specific links in their place later.

✔️ Acceptance criteria

  • The "Single document" and "Surrounding documents" links are not shown in the log-explorer document fly-out.

🎨 Visuals

image

💡 Implementation hints

  • A customization point for these links would allow us to place alternative, observaility-specific actions in their place in the future. For now the customized content could just be empty to remove the links.
@weltenwort weltenwort added Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v8.11.0 labels Aug 30, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/infra-monitoring-ui (Team:Infra Monitoring UI)

@formgeist formgeist changed the title [Log Explorer] Remove Discover links from log explorer document fly-out [Explorer] Remove Discover links from log explorer document fly-out Sep 6, 2023
@tonyghiani tonyghiani self-assigned this Sep 14, 2023
@tonyghiani tonyghiani mentioned this issue Sep 18, 2023
Merged
tonyghiani added a commit that referenced this issue Sep 21, 2023
@tonyghiani
[Log Explorer] Hide hard coded flyout actions using customization ext…
0743a11 
…ension point (#166638)

## 📓 Summary

Closes #165217 

This work implements a new extension point in the Discover customization
framework to allow customizing the flyout content. Although it enables
customizing only the actions displayed on top, it could be enhanced for
additional flyout customizations in the future.

To keep it simple and familiar to other customizations, it relies on a
similar API as the `top_nav` customization, allowing one to disable
default actions and insert additional ones.

```ts
/**
 * Hide flyout actions to prevent rendering hard-coded actions.
 */
customizations.set({
  id: 'flyout',
  actions: {
    defaultActions: {
      viewSingleDocument: { disabled: true },
      viewSurroundingDocument: { disabled: true },
    },
  },
});
```

## 🧪 Testing 
- Navigate to `/app/observability-log-explorer` and expand the flyout
for any grid entry.
The actions on top of the flyout should not be displayed, only the title
and the pagination control should appear.
- Navigate to `/app/discover` and expand the flyout for any grid entry. 
The actions for viewing a single documents or surrounding documents
should be displayed.

---------

Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani@elastic.co>
gergoabraham pushed a commit to gergoabraham/kibana that referenced this issue Sep 21, 2023
@tonyghiani @gergoabraham
[Log Explorer] Hide hard coded flyout actions using customization ext…
d974605 
…ension point (elastic#166638)

## 📓 Summary

Closes elastic#165217 

This work implements a new extension point in the Discover customization
framework to allow customizing the flyout content. Although it enables
customizing only the actions displayed on top, it could be enhanced for
additional flyout customizations in the future.

To keep it simple and familiar to other customizations, it relies on a
similar API as the `top_nav` customization, allowing one to disable
default actions and insert additional ones.

```ts
/**
 * Hide flyout actions to prevent rendering hard-coded actions.
 */
customizations.set({
  id: 'flyout',
  actions: {
    defaultActions: {
      viewSingleDocument: { disabled: true },
      viewSurroundingDocument: { disabled: true },
    },
  },
});
```

## 🧪 Testing 
- Navigate to `/app/observability-log-explorer` and expand the flyout
for any grid entry.
The actions on top of the flyout should not be displayed, only the title
and the pagination control should appear.
- Navigate to `/app/discover` and expand the flyout for any grid entry. 
The actions for viewing a single documents or surrounding documents
should be displayed.

---------

Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani@elastic.co>
@gbamparop gbamparop added Feature:LogsExplorer Logs Explorer feature and removed Feature:Logs UI Logs UI feature labels Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tonyghiani tonyghiani

Labels
Feature:LogsExplorer Logs Explorer feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v8.11.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Logs Explorer] Hide hard coded flyout actions using customization extension point tonyghiani/kibana
4 participants
@weltenwort @gbamparop @elasticmachine @tonyghiani