Skip to content

Commit 6079ff7

Browse files
committed
refactor: clean and update the doc
1 parent 55f4cca commit 6079ff7

16 files changed

Lines changed: 111 additions & 76 deletions

File tree

docs/user/Dashboard/list_and_share_applications.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ By default, a few application instances are displayed (e.g., `My Jobs`, an insta
2525
2. Select **Rename**.
2626
- :bulb: The instance name will change to an input field.
2727
3. Enter a new name and press **Enter** to save it.
28+
- :bulb: You can't use the same name for several intances
2829

2930
### Moving an Application Instance
3031

@@ -42,13 +43,16 @@ By default, a few application instances are displayed (e.g., `My Jobs`, an insta
4243

4344
### Sharing Your Dashboard
4445

45-
1. Copy the URL from your browser.
46-
- :bulb: The URL encodes the current state of your dashboard.
47-
2. Share it with others.
48-
- :warning: The recipient will see a similar dashboard layout but may not see identical content if:
49-
- They belong to a different VO or group.
50-
- Time-sensitive data has changed since sharing.
51-
- :warning: Encoding too many application instances may create discrepancies as the URL has a theoretical limit of 8000 characters based on [RFC9110](https://www.rfc-editor.org/rfc/rfc9110#section-4.1-5)
46+
1. Click on the **Export** button at the top-right corner of the page.
47+
2. Select the instances you want to share.
48+
- :bulb: You can select a group to select all instances within that group.
49+
- :bulb: For each instance, the shared content will include the name you gave it and the settings you configured.
50+
3. Click on **Export N Selected**.
51+
- :bulb: A menu will appear with a text box containing the exported JSON.
52+
4. Click on the **Copy to Clipboard** button.
53+
5. Send this text to the person you want to share it with.
54+
- :bulb: If you're using **Mattermost**, you can wrap the text with triple backticks (```) to display it nicely.
55+
5256

5357
## Advanced Features
5458

@@ -91,11 +95,4 @@ When managing multiple instances of the same application, grouping can help you
9195
2. Select **Delete**.
9296
- :bulb: The group and all its application instances will disappear from the sidebar.
9397

94-
95-
### Share and import the settings of an application
96-
97-
1. **Share**: You can export the status of an app by clicking on the share button in the top-right corner of the screen. After clicking, you can select which group and app you want to share and then copy a text corresponding to the states of the selected applications.
98-
99-
2. **Import**: Next to the export button you can find the import button. You can paste into the window opened by the button the text corresponding to one or multiple shared apps. This will create a new group named *Imported App* with the imported applications and their settings.
100-
10198
**Good to know:** When switching to a new version, the settings you are trying to import may no longer be valid. In this case, a new window will appear, offering to resolve the issue by updating the state copied to your clipboard. This updated version preserves your imported rules as much as possible.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Manage Your Jobs
2+
3+
## Change Their Statuses
4+
5+
You can select one or more jobs by clicking on the checkboxes next to each job. Once jobs are selected, you can perform actions on them using the buttons at the top of the table. The available actions include:
6+
7+
- **Reschedule**: Reschedules the selected jobs.
8+
- **Kill**: Marks the selected jobs as `KILLED`.
9+
- **Delete**: Marks the selected jobs as `DELETED`.
10+
11+
**Note**:
12+
- You can only delete jobs that are already killed.
13+
- A job cannot be rescheduled more than three times.
14+
15+
## View a Job's History
16+
17+
You can right-click on a job to open its **Job History**.
18+
The history shows the different statuses the job has gone through, along with the corresponding dates and the authors of the changes.
19+

docs/user/Job_Monitor/monitor_jobs.md

Lines changed: 0 additions & 34 deletions
This file was deleted.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# The Search Bar
2+
3+
The search bar allows you to filter jobs based on various criteria. Filters are represented as equations, where each equation consists of a job attribute, an operator, and a value. The search bar analyzes these equations to evaluate their consistency. A green equation is valid, a yellow equation is incomplete, and a red equation is invalid.
4+
5+
A search is automatically performed when all equations in the search bar are valid.
6+
7+
## Create a Filter
8+
9+
To create a filter, click on the search bar and start typing. Suggestions will appear based on the available job attributes. You can select a suggestion to choose the criterion. After that, you can either type or select an operator and a value to filter by.
10+
The search bar only suggests attributes, operators, and values that are available in your current set of jobs.
11+
12+
## Edit a Filter
13+
14+
To edit a filter, click on it in the search bar. You can change the operator or value by clicking on them. You can also use the arrow keys to navigate through the equations and edit them. Press `ESCAPE` to return to the end of the search bar.
15+
16+
## Remove a Filter
17+
18+
To remove a filter, press the `Backspace` key to remove the last token, or right-click on the equation to remove the entire equation.
19+
You can also clear the entire search bar by clicking on the trash can button at the end of the search bar.

docs/user/Job_Monitor/use_table.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# The Table
2+
3+
The table displays the jobs that match the criteria specified in the search bar. Each row represents a job, and the columns show various attributes of the job, such as its ID, status, type, and submission date.
4+
5+
## Change the Visibility
6+
7+
You can click on the eye icon to select additional columns to display in the table. Some columns are hidden by default.
8+
9+
You can sort the table by clicking on the column headers. Clicking once will sort the table in ascending order; clicking again will sort it in descending order.
10+
11+
You can set the page size by using the `Rows per page` dropdown at the bottom of the table. This allows you to control how many jobs are displayed per page.
12+
13+
## Select a Job
14+
15+
You can select one or multiple jobs using the checkboxes on the left side of the table.
16+
Once you have selected at least one job, you can perform actions on it. You can manage the selected jobs or copy their IDs to your clipboard.

docs/user/generalUsage.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
# General usage
1+
# General Usage
22

3-
## Navigate between applications
3+
## Navigate Between Applications
44

5-
You can click on the \`Add application\` button to create a new instance of an application. The list of open instances appears in the sidebar on the left. Clicking on one of these instances will display it in the center of the dashboard
5+
You can click on the `Add application` button to create a new instance of an application.
6+
The list of open instances appears in the sidebar on the left. Clicking on one of these instances will display it in the center of the dashboard.
67

7-
## Share applications
8+
## Share Applications
89

9-
To share applications, click the \`Export\` button at the top right of the screen. Then, select the applications you want to share and copy them to the clipboard.
10+
To share applications, click the `Export` button at the top right of the screen.
11+
Then, select the applications you want to share and copy them to the clipboard.
1012

11-
## Import applications
13+
## Import Applications
1214

13-
To import applications, click the \`Import\` button at the top right of the screen. Paste the copied applications into the input field and click \`Import\`. The imported applications will appear in the sidebar.
14-
If the states are outdated, you can copy the updated version of them by clicking the \`Copy all updated states\` button.
15+
To import applications, click the `Import` button at the top right of the screen.
16+
Paste the copied applications into the input field and click `Import`. The imported applications will appear in the sidebar.
17+
If the states are outdated, you can copy the updated version of them by clicking the `Copy all updated states` button.
1518

16-
## Save you dashoard
17-
To save your dashboard, clicke the \`Export\`button at the top right of the screen. Then, select the applications you want to save and click on the \`Save in the browser\` button. The saved applications will be stored in your browser's local storage.
18-
When you want to load the saved applications, click the \`Import\` button at the top right of the screen and select the \`Load from the browser\` option. The saved applications will be loaded into the sidebar.
19+
## Save Your Dashboard
20+
21+
To save your dashboard, click the `Export` button at the top right of the screen.
22+
Then, select the applications you want to save and click the `Save in the browser` button. The saved applications will be stored in your browser's local storage.
23+
When you want to load the saved applications, click the `Import` button at the top right of the screen and select the `Load from the browser` option.
24+
The saved applications will be loaded into the sidebar.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
"doc:diracx-web-components": "npm --prefix packages/diracx-web-components run doc",
2323
"lint": "npm --prefix packages/diracx-web-components run lint && npm --prefix packages/diracx-web run lint",
2424
"ts-lint": "npm --prefix packages/diracx-web-components run ts-lint && npm --prefix packages/diracx-web run ts-lint",
25-
"prepare": "husky"
25+
"prepare": "husky",
26+
"generate-doc": "npm --prefix packages/diracx-web-components run generate-doc && npm --prefix packages/extensions run generate-doc"
2627
}
2728
}

packages/diracx-web-components/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"access": "public"
88
},
99
"scripts": {
10-
"build": "node script/generateDocs && tsup --minify",
10+
"build": "npm run generate-doc && tsup --minify",
1111
"dev": "tsup --watch",
1212
"test": "jest --ci",
1313
"lint": "eslint ./src",
@@ -16,7 +16,7 @@
1616
"prepack": "rm -rf dist && npm run build",
1717
"doc": "storybook dev -p 6006",
1818
"build-doc": "storybook build",
19-
"generate-docs": "node script/generateDocs.js"
19+
"generate-doc": "node script/generateDoc.js"
2020
},
2121
"license": "GPL-3.0",
2222
"type": "module",
File renamed without changes.

packages/diracx-web-components/src/components/DashboardLayout/HelpOverlay.tsx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export default function HelpOverlay({
7474
variant: "h5",
7575
gutterBottom: true,
7676
sx: {
77-
marginTop: "0.75rem",
77+
marginTop: "1rem",
7878
marginBottom: "0.25rem",
7979
},
8080
} as React.HTMLProps<HTMLHeadingElement>,
@@ -145,6 +145,7 @@ export default function HelpOverlay({
145145
>
146146
<CloseIcon />
147147
</IconButton>
148+
148149
<Box
149150
sx={{ width: 250, borderRight: "1px solid #ddd", overflowY: "auto" }}
150151
>
@@ -190,7 +191,7 @@ export default function HelpOverlay({
190191
</Box>
191192

192193
{/* Right content pane */}
193-
<Box sx={{ flex: 1, p: 3, overflowY: "auto" }}>{RenderContent()}</Box>
194+
<Box sx={{ flex: 1, p: 4, overflowY: "auto" }}>{RenderContent()}</Box>
194195
</Box>
195196
</Modal>
196197
);

0 commit comments

Comments
 (0)