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

IBX-7036: Customizable dashboard described in Developer documentation #2244

Merged
merged 7 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/administration/dashboard/configure_default_dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Default dashboard configuration
description: Configure default dashboard.
---

# Configure default dashboard
39 changes: 39 additions & 0 deletions docs/administration/dashboard/customize_dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---

Check warning on line 1 in docs/administration/dashboard/customize_dashboard.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/dashboard/customize_dashboard.md#L1

[Ibexa.ReadingLevel] The grade level is 8.27. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 8.27. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/administration/dashboard/customize_dashboard.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
title: Dashboard customization
description: Customize dashboard.
---

# Customize dashboard

You can customize the dashboard depending on your needs using Dahboard Builder.
Customized dashboard previews a set of widgets selected by the user.
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

!!! tip

Detailed instruction on how to customize dashboard using Dashboard Builder is available in [[[= product_name =]] user documentation](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/discover_ui/).

## Manage permissions

In order to be able to customize dashboard, you need to have `dashboard/cutomize` [policy](permission_overview.md).

Check warning on line 17 in docs/administration/dashboard/customize_dashboard.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/dashboard/customize_dashboard.md#L17

[Ibexa.Wordy] Remove 'in order' and leave 'to'.
Raw output
{"message": "[Ibexa.Wordy] Remove 'in order' and leave 'to'.", "location": {"path": "docs/administration/dashboard/customize_dashboard.md", "range": {"start": {"line": 17, "column": 1}}}, "severity": "WARNING"}
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

By default, all the users belonging to the `Editors` User Group, have `Dashboard`[Role](roles_admin_panel.md) assigned, so they can edit, create, or delete dashboard.
If, by any reason, you want to narrow this permission, you can set up specific [limitations](limitations.md).

## Add custom layout

For new dashboard you need to choose layout which defines the available zones.
While opening Dashboard Builder, layout window appears - you can choose one from available layouts.

Check warning on line 25 in docs/administration/dashboard/customize_dashboard.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/dashboard/customize_dashboard.md#L25

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.", "location": {"path": "docs/administration/dashboard/customize_dashboard.md", "range": {"start": {"line": 25, "column": 15}}}, "severity": "WARNING"}

You can also add custom layout that then can be available in Dashboard Builder.

Check warning on line 27 in docs/administration/dashboard/customize_dashboard.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/dashboard/customize_dashboard.md#L27

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.", "location": {"path": "docs/administration/dashboard/customize_dashboard.md", "range": {"start": {"line": 27, "column": 62}}}, "severity": "WARNING"}

For more information, see [Customize storefront layout](customize_storefront_layout.md).

## Create custom blocks

Dashboard builder provides set of ready-to-use blocks, for example, Common content, Quick actions, or [[= product_name =]] News.

For more information about available blocks, see [[[= product_name =]] user documentation](https://doc.ibexa.co/projects/userguide/en/latest/getting_started/dashboard_block_reference/).

In addition to existing blocks available in Dashboard Builder, you can also create custom blocks.

Check warning on line 37 in docs/administration/dashboard/customize_dashboard.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/dashboard/customize_dashboard.md#L37

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.", "location": {"path": "docs/administration/dashboard/customize_dashboard.md", "range": {"start": {"line": 37, "column": 45}}}, "severity": "WARNING"}

To do it, follow the instruction on how to [create custom Page block](create_custom_page_block.md).
8 changes: 8 additions & 0 deletions docs/administration/dashboard/php_api_dashboard_service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---

Check warning on line 1 in docs/administration/dashboard/php_api_dashboard_service.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/dashboard/php_api_dashboard_service.md#L1

[Ibexa.ReadingLevel] The grade level is 6.01. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 6.01. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/administration/dashboard/php_api_dashboard_service.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
title: PHP API Dashboard service
description: PHP API Dashboard service
---

# PHP API Dashboard service

Check warning on line 6 in docs/administration/dashboard/php_api_dashboard_service.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/dashboard/php_api_dashboard_service.md#L6

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.", "location": {"path": "docs/administration/dashboard/php_api_dashboard_service.md", "range": {"start": {"line": 6, "column": 11}}}, "severity": "WARNING"}
julitafalcondusza marked this conversation as resolved.
Show resolved Hide resolved

You can use PHP API Dashboard service to manage dashboards.

Check warning on line 8 in docs/administration/dashboard/php_api_dashboard_service.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/administration/dashboard/php_api_dashboard_service.md#L8

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard'.", "location": {"path": "docs/administration/dashboard/php_api_dashboard_service.md", "range": {"start": {"line": 8, "column": 21}}}, "severity": "WARNING"}
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ nav:
- Project organization: administration/project_organization/project_organization.md
- Architecture: administration/project_organization/architecture.md
- Bundles: administration/project_organization/bundles.md
- Dashboard:
- Configure default dashboard: administration/dashboard/configure_default_dashboard.md
- Customize dashboard: administration/dashboard/customize_dashboard.md
- PHP API Dashboard service: administration/dashboard/php_api_dashboard_service.md
- Admin panel:
- Admin panel: administration/admin_panel/admin_panel.md
- Users: administration/admin_panel/users_admin_panel.md
Expand Down