Skip to content

Commit

Permalink
update docs according to formation
Browse files Browse the repository at this point in the history
  • Loading branch information
fdewas-aneo committed May 27, 2024
1 parent 02838bf commit 7d93fe6
Show file tree
Hide file tree
Showing 9 changed files with 55 additions and 42 deletions.
4 changes: 4 additions & 0 deletions .docs/components/global/Center.vue
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,8 @@ article {
padding: none;
margin: none;
}
article * {
margin: auto;
}
</style>
35 changes: 26 additions & 9 deletions .docs/components/global/HorizontalArea.vue
Original file line number Diff line number Diff line change
@@ -1,27 +1,34 @@
<template>
<section>
<div :style="`width:${left}%`">
<div id="left">
<slot name="left" />
</div>
<div :style="`width:${right}%`">
<div id="right">
<slot name="right" />
</div>
</section>
</template>

<script setup>
const props = defineProps({
left: Number,
right: Number,
left: String,
right: String,
justifyRight: String,
});
if (!props.left && !props.right) {
props.left = 50;
props.right = 50;
const justifyRight = props.justifyRight || 'center';
let right = 50;
let left = 50;
if (props.left && props.right) {
left = `${Number(props.left)}%`;
right = `${Number(props.right)}%`;
} else if (!props.right) {
props.right = 100 - Number(props.left);
left = `${Number(props.left)}%`;
right = `${100 - Number(props.left)}%`;
} else if (!props.left) {
props.left = 100 - Number(props.right);
right = `${Number(props.right)}%`;
left = `${100 - Number(props.right)}%`;
}
</script>
Expand All @@ -33,4 +40,14 @@ section {
justify-content: space-between;
align-items: center;
}
#left {
width: v-bind('left');
}
#right {
width: v-bind('right');
display: flex;
justify-content: v-bind('justifyRight');
}
</style>
4 changes: 4 additions & 0 deletions .docs/content/2.layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,19 @@

The layout of ArmoniK is quite simple. It is composed of a [header](#header), a [navigation bar](#navigation-bar) and the [main content](#main-content) of the page.

::center
![\[Image\] ArmoniK GUI Dashboard Layout](/armonik-layout.png)
::

## Main Content

Every page display its name at the top left of the screen. In the top right corner, you will find a **"copy url"** button to share the page with others.

## Header

::center
![\[Image\] ArmoniK GUI Header](/armonik-header.png)
::

The left side of the header is purely informational. You can retrieve your profile name (`Anonymous`).

Expand Down
6 changes: 2 additions & 4 deletions .docs/content/4.Dashboard.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# Dashboard

The Dashboard is the landing page of ArmoniK. It can be personnalized for a unique experience.

::alert{type="warning"}
The Dashboard may change in future versions.
::

## Organization
The Dashboard is the landing page of ArmoniK. It allows the user to have a simple and personnalized view of the ArmoniK Cluster. Anyone can simply add or delete DataGrids to the Dashboard.

::horizontal-area
#left
The dashboard is organized into lines. By default, a line can receive a single [component](#components). A line can be splited in order to receive more components.

Most of the magic relies on the **Dashboard configuration panel** at the bottom right of the screen. It will permit you to:
Most of the magic relies on the **Dashboard configuration panel** at the bottom right of the page. It will permit you to:

- Add a component.
- Split the lines.
Expand Down
2 changes: 1 addition & 1 deletion .docs/content/5.inspection-page.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Inspection Pages

Inspection pages are usefull when you want to display every information about a single item. They are available for [Partitions](./7.Data/2.Partitions.md), [Sessions](./7.Data/3.Sessions.md), [Tasks](./7.Data/4.Tasks.md) and [Results](./7.Data/5.Results.md) pages.
Inspection pages are usefull when you want to display every information about a single item. They are available for [Partitions](./7.Data/2.Partitions.md), [Sessions](./7.Data/3.Sessions.md), [Tasks](./7.Data/4.Tasks.md) and [Results](./7.Data/5.Results.md).

::center
![[Image] Inspection Page example](/inspection-page.png)
Expand Down
10 changes: 7 additions & 3 deletions .docs/content/6.DataGrids/3.columns.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Statuses are **always sortable and filterable**.
#left
This column is only available to [Applications](../5.Data/1.Applications.md), [Partitions](../5.Data/2.Partitions.md) and [Sessions](../7.Data/3.Sessions.md) Datagrids, and display the number of tasks grouped by one or more status.

You can click on one number to be redirected to the [Tasks](../7.Data/4.Tasks.md) page, filtered by the desired statuses.
The tasks of a session, application or partition will be grouped by their statuses in this column. A "Status Group" can group many statuses. Clicking on a group will redirect you to the [Tasks Datagrid](../7.Data/4.Tasks.md), filtered by the desired statuses.

You can edit the displayed statuses by clicking on the button next to `Tasks by Statuses` in the column header.

Expand All @@ -74,9 +74,13 @@ Tasks by Statuses columns are **not filterable and sortable**.

## Custom Columns

The custom columns are available for [Sessions](../7.Data/3.Sessions.md) and [Tasks](../7.Data/4.Tasks.md) datagrids. They represent values that are not available by default in ArmoniK. They represent a field of the `Custom Data` object column. By adding a custom column, you can display a new column.
Some data fields are not available in ArmoniK. Those fields are unique for each application and might contains important information about the run. Since they change from a user to another, the GUI cannot have them by default.

You can add, edit or delete a custom columns via the button `Manage Custom Columns` in the `Options` actions in the top right corner of the toolbar.
To display those data fields, you can use custom columns. Those columns will look for the data located in the `options.options` (displayed as the "Custom Data" column) field of a task or session.

The custom columns are available for [Sessions](../7.Data/3.Sessions.md) and [Tasks](../7.Data/4.Tasks.md) datagrids. They represent values that are not available by default in ArmoniK.

You can add, edit or delete a custom columns via the button `Manage Custom Columns` in the `Options` actions in the top right corner of the toolbar. You will then be able to indicate the field you want to add.

::alert{type="warning"}
When adding custom columns, be careful to name them correctly. They are case sensitive, so a misplaced capital letter may break a column, and no data will be displayed.
Expand Down
4 changes: 2 additions & 2 deletions .docs/content/7.Data/3.Sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@

#### Badges explanation

::horizontal-area{right=90}
::horizontal-area{right='90' justifyRight='start'}
#left
:badge[Options]{type="info"}

#right
Fields with this badge are parts of the **Tasks Options** field.
::

::horizontal-area{right=90}
::horizontal-area{right='90' justifyRight='start'}
#left
:badge[Computed]{type="warning"}

Expand Down
2 changes: 1 addition & 1 deletion .docs/content/7.Data/4.Tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

#### Badges explanation

::horizontal-area{right=90}
::horizontal-area{right=90 justifyRight='start'}
#left
:badge[Options]{type="info"}

Expand Down
30 changes: 8 additions & 22 deletions .docs/content/8.Settings/0.navigation.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,15 @@
# Navigation settings

You can modify the navigation bar in the left area of the settings page. It is composed of pages and dividers (visual elements).
You can modify the navigation bar in the left area of the settings page. It is composed of pages and dividers (visual separator).

## Adding a page
In the settings, the navigation bar is displayed as a list of elements. Every one of them is composed of an icon, a name and an action.

Click on `+ Add a status` at the bottom of the list. If you want, you can have the same page twice.
- You can **drag the icon** to **update the order** of the navigation bar list.
- You can **click on the name** and **select a page** to directly change the page.
- You can **open the action menu** and **click on remove** the remove the current element from the list.

## Updating order
To **add a new page**, click on `+ Add a status` at the bottom of the list. Nothing prevents you from displaying the same page twice.

You can simply drag and drop an element by its **icon** of the list to another position.
When you are **done modifying**, click on the `save` button to update the navigation bar.

## Changing an element

To change an element, click on its name. A list should appear. You can then update the element by another.

## Removing an element

To remove an element, open the actions menu by clicking on the dots right next to the element name, and click on `remove`.

## Saving modification

You can find a `save` button at the bottom of the page.

## Reseting

You can reset to your previously saved version of the navigation bar by clicking on `Reset`.

You can also reset to the default values by clicking on `Reset to default`.
If you want to reset to your last saved modification, click on `reset`. You can also reset to the default values by clicking on `Reset to default`.

0 comments on commit 7d93fe6

Please sign in to comment.