Skip to content

Commit

Permalink
Merge pull request #161 from jbokyung2/master
Browse files Browse the repository at this point in the history
A guide for 'Dashboards' updated in english
  • Loading branch information
jbokyung2 authored Oct 16, 2023
2 parents 5a7a9e1 + 20f0601 commit 989f76b
Show file tree
Hide file tree
Showing 118 changed files with 795 additions and 18 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/guides/administration/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Administration"
linkTitle: "Administration"
weight: 6
weight: 7
date: 2022-06-27
description: >
In the **Administration** page, you can manage and edit information, roles, policies, etc. of domain users.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guides/advanced/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Advanced feature"
linkTitle: "Advanced feature"
weight: 9
weight: 10
date: 2022-06-07
description: >
**Advanced features** are designed to use Cloudforet more conveniently.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guides/alert-manager/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Alert manager"
linkTitle: "Alert manager"
weight: 5
weight: 6
date: 2022-06-07
description: >
**Alert manager** in Cloudforet is a service to integrate and manage events of diverse patterns that occur in multiple monitoring systems.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guides/asset-inventory/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Asset inventory"
linkTitle: "Asset inventory"
weight: 3
weight: 4
date: 2022-06-07
description: >
**Asset inventory** allows a user to collect resources based on the registered user cloud service account, and view the collected resources.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guides/cost-explorer/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Cost Explorer"
linkTitle: "Cost Explorer"
weight: 4
weight: 5
date: 2022-06-24
description: >
**Cost Explorer** feature traces all expenses incurred from service accounts registered in Cloudforet.
Expand Down
12 changes: 12 additions & 0 deletions content/en/docs/guides/dashboards/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Dashboards"
linkTitle: "Dashboards"
weight: 2
date: 2023-10-16
description: >
Dashboard service that visually represents (multi) cloud data, such as billing and assets, making complex data easy to understand at a glance. With support for various chart types and graphic elements, you can quickly grasp the essentials of your critical data.
<br>
<br>
You can [**create customized dashboards**](/docs/guides/dashboards/create) by combining specific widgets to gain a quick overview of your desired data in addition to the [**default provided dashboards**](/docs/guides/dashboards/template). Furthermore, you can have precise control over variables, date ranges, and detailed options for each widget for each dashboard, allowing you to build and manage more accurate and professional dashboards tailored to your organization's requirements."
---
55 changes: 55 additions & 0 deletions content/en/docs/guides/dashboards/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: "Create Dashboard"
linkTitle: "Create Dashboard"
weight: 4
date: 2023-10-16
description: >
You can create and manage custom dashboards by utilizing various widgets based on the importance and characteristics of your data, in addition to the provided default dashboards.
---

## Creating a new dashboard

You can create a dashboard following the steps below.
<br>
<br>

(1) To create a new dashboard, you can either click on **[Dashboard > Create New Dashboard]** in the top menu or click the [+] button at the top of the left-hand menu within the dashboard service to go to the creation page.

![dashboard-create-01](/docs/guides/dashboards/dashboard-img/dashboard-create-01.png)

![dashboard-create-02](/docs/guides/dashboards/dashboard-img/dashboard-create-02.png)

<br>

(2) On the "Create New Dashboard" page, select the dashboard scope and choose whether it should be public or not.

![dashboard-create-03](/docs/guides/dashboards/dashboard-img/dashboard-create-03.png)

- **Entire Workspace** : The data for the entire workspace's projects will be displayed.
- **Single Project** : The dashboard will be configured using only the data from a chosen project.

<br>

(3) You can select from the default templates provided by Cloudforet or choose to duplicate an existing dashboard. After selecting your preferred options, click the [Continue] button.

![dashboard-create-04](/docs/guides/dashboards/dashboard-img/dashboard-create-04.png)

<br>

(4) After entering the dashboard name, you can complete creating the dashboard using the provided widgets. For detailed editing instructions, refer to [**here**](/docs/guides/dashboards/edit).

![dashboard-create-05](/docs/guides/dashboards/dashboard-img/dashboard-create-05.png)

<br>

(5) The created dashboard can be found on the [View All Dashboards] page, categorized based on [viewers] and [scope].

![dashboard-create-06](/docs/guides/dashboards/dashboard-img/dashboard-create-06.png)

<br>

To review the created dashboard and make quick adjustments, please refer to [**here**](/docs/guides/dashboards/view).



Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
132 changes: 132 additions & 0 deletions content/en/docs/guides/dashboards/edit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
title: "Customize Dashboard"
linkTitle: "Customize Dashboard"
weight: 5
date: 2023-10-16
description: >
In the dashboard [Customize] mode, you can modify the dashboard name, layout, widgets, and more.
---

## Customizing your dashboard

### Switch to 'Customize' mode

Clicking the [Customize] button on the right side of a dashboard page will take you to the dashboard editing page.

![dashboard-edit-intro-01](/docs/guides/dashboards/dashboard-img/dashboard-edit-intro-01.png)

<br>

### Rename the dashboard

You can click the [Edit] icon button next to the dashboard title to make changes.

![dashboard-edit-name-01](/docs/guides/dashboards/dashboard-img/dashboard-edit-name-01.png)

<br>

### Manage labels

You can add or remove labels just below the dashboard title at the top. Labels are used to categorize and differentiate dashboard-related categories and features, making them useful for dashboard searches.

![dashboard-edit-label-01](/docs/guides/dashboards/dashboard-img/dashboard-edit-label-01.png)

<br>

### Apply a period range

(1) When you activate the [Date Range Selector] option from the right side panel, a dropdown button for setting the period will be displayed on the dashboard.

![dashboard-edit-duration-01](/docs/guides/dashboards/dashboard-img/dashboard-edit-duration-01.png)

(2) You can select a specific month from the drop-down or choose a specific month within the last 3 years using the [Custom] menu.

![dashboard-edit-duration-02](/docs/guides/dashboards/dashboard-img/dashboard-edit-duration-02.png)

{{<alert>}}
Even when you activate the date range selector option, it doesn't apply to all widgets. Depending on the widget's characteristics, some widgets allow applying the date range, while others do not.
{{</alert>}}

<br>

### Configure auto data refresh

You can choose the data refresh interval from the [Refresh] dropdown in the upper right corner of the dashboard.

![dashboard-edit-refresh-01](/docs/guides/dashboards/dashboard-img/dashboard-edit-refresh-01.png)

<br>

### Add widgets

(1) Click the [+ Add Widget] button on the right-hand dashboard editing page.

![dashboard-edit-add-widget-01](/docs/guides/dashboards/dashboard-img/dashboard-edit-add-widget-01.png)

<br>

(2) Select a specific widget from the list on the left and add it.

![dashboard-edit-add-widget-02](/docs/guides/dashboards/dashboard-img/dashboard-edit-add-widget-02.png)

{{<alert>}}
You can choose from a variety of widgets based on the [Cost], [Assets], and [Alert] categories. (More widgets will be continuously updated)
{{</alert>}}


(2-2) If you have selected a specific widget, you can enter the [Name] and set the detailed options.

![dashboard-edit-add-widget-03](/docs/guides/dashboards/dashboard-img/dashboard-edit-add-widget-03.png)

{{<alert>}}
**[Inherit] On/Off:** Options provided for each widget are, for the most part, initially set to inherit the dashboard's variables as the default. 'Inheriting from the dashboard' means that when you change the options of a variable at the dashboard level, those changes are automatically applied to the widgets that have options that inherit from it. Conversely, when a specific option is set to non-inherited, changes to the variable at the dashboard level won't affect that widget.
<br>
e.g. In the Cost Map widget, the `Project` option is set to 'Inherit' and if you filter `Project` to 'Project A' at the dashboard level, the widget will now display data relevant to 'Project A' only.
{{</alert>}}

{{<alert>}}
**Return to initial settings:** Each widget comes with default option values corresponding to the dashboard's variables by default. Even if you've made multiple changes to widget options during the dashboard configuration process, clicking the [Return to initial settings] button will easily revert to the initially set default option values.
{{</alert>}}


(2-3) If there are no additional options you want, you can click the [+Add Option] button to add them.

![dashboard-edit-add-widget-04](/docs/guides/dashboards/dashboard-img/dashboard-edit-add-widget-04.png)

(2-4) When you've finished the configuration, click the [Confirm] button to complete adding widgets to the dashboard.


<br>

### Rearrange the widget order

You can change the order by drag & drop the widget name button from the widget list in the right panel.

![dashboard-edit-change-widget-01](/docs/guides/dashboards/dashboard-img/dashboard-edit-change-widget-01.png)


<br>

### Enlarge widget size

If you want to view a widget in full-screen, click the [Full Screen] icon button in the top right corner of the widget.

![dashboard-edit-full-screen-01](/docs/guides/dashboards/dashboard-img/dashboard-edit-full-screen-01.png)

![dashboard-edit-full-screen-02](/docs/guides/dashboards/dashboard-img/dashboard-edit-full-screen-02.png)


<br>

### Edit a widget

(1) Click the [Edit] icon button in the top right corner of the widget to edit it.

![dashboard-update-widget-01](/docs/guides/dashboards/dashboard-img/dashboard-update-widget-01.png)

(2) You can edit the widget name and options, then click the [Confirm] button to save your changes. However, if you don't [Save] the dashboard in [Customize] mode, the edited widget won't be reflected in the final version.

- For information on widget option settings, please refer to [**here**](/docs/guides/dashboards/edit/#위젯-추가하기).

![dashboard-update-widget-02](/docs/guides/dashboards/dashboard-img/dashboard-update-widget-02.png)
33 changes: 33 additions & 0 deletions content/en/docs/guides/dashboards/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: "Dashboard Templates"
linkTitle: "Dashboard Templates"
weight: 3
date: 2023-10-16
description: >
Using the default templates makes it easier and faster to create a dashboard.
---


## Monthly Cost Summary

This is a dashboard that visualizes cloud cost status and budget utilization based on various group-specific statistical criteria in the form of charts.

It is comprised of cost-related widgets, and among the dashboard variables, one specific Data-Source must be selected.

![dashboard-basic-page-01](/docs/guides/dashboards/dashboard-img/dashboard-basic-page-01.png)

<br>

## CDN & Traffic

This is a dashboard that charts the status of CDN and traffic-related costs and usage for a specific cloud product. One specific Data-Source must be selected.

![dashboard-basic-page-02](/docs/guides/dashboards/dashboard-img/dashboard-basic-page-02.png)

<br>

## Compliance Overview

This is a dashboard that visualizes compliance configuration audit and monitoring results. One specific Data-Source must be selected.

![dashboard-basic-page-03](/docs/guides/dashboards/dashboard-img/dashboard-basic-page-03.png)
Loading

0 comments on commit 989f76b

Please sign in to comment.