Skip to content

docs: changes from GitBook #200

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: changes from GitBook #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/first-time-users/access-your-idea-cluster/apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# APIs

{% hint style="info" %}
To see all APIs available, refer to APIs section for each [Broken link](broken-reference "mention").
To see all APIs available, refer to APIs section for each [https://github.com/cfs-energy/idea/blob/main/docs/first-time-users/access-your-idea-cluster/broken-reference/README.md](https://github.com/cfs-energy/idea/blob/main/docs/first-time-users/access-your-idea-cluster/broken-reference/README.md "mention").
{% endhint %}

All actions performed by IDEA web interface can also be triggered via HTTP APIs. APIs cover all modules such as creating IDEA users, submit a job or control virtual desktops.
Expand Down
4 changes: 2 additions & 2 deletions docs/first-time-users/access-your-idea-cluster/web-interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ IDEA includes a web-interface designed to simplify user-experience for your end-

<mark style="color:orange;">**Orange**</mark>: Admin Zone. This section is only visible to users with admin privileges

<mark style="color:green;">**Green**</mark>: [Broken link](broken-reference "mention") section displaying installed/available modules such as:
<mark style="color:green;">**Green**</mark>: [Modules](https://app.gitbook.com/s/f38qThSa0Aa40txosxbS/modules "mention") section displaying installed/available modules such as:

* [hpc-workloads](../../modules/hpc-workloads/ "mention")
* [virtual-desktop-interfaces](../../modules/virtual-desktop-interfaces/ "mention")
* [cluster-manager](../../modules/cluster-manager/ "mention")

Refer to the [Broken link](broken-reference "mention") for an up-to-date list of modules supported by IDEA
Refer to the [Modules](https://app.gitbook.com/s/f38qThSa0Aa40txosxbS/modules "mention") for an up-to-date list of modules supported by IDEA

<mark style="color:yellow;">**Yellow**</mark>: User settings and notifications. View account info, change IDEA preferences, reset your password and more.

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/hpc-workloads/admin-documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ HPC workload administrators have extensive capabilities to manage job submission
* [Web-Based Job Submission](create-web-based-job-submission-workflows.md) - Create custom forms for simplified job submission
* [License Resources](configure-floating-license-resources.md) - Manage floating license resources for applications
* [Custom AMIs](custom-amis.md) - See which images the cluster launches from and build new ones from the portal
* [OpenPBS Hooks](openpbs-hooks.md) - Understand and configure OpenPBS hooks used by IDEA
* [OpenPBS Hooks](https://github.com/cfs-energy/idea/tree/main/docs/modules/hpc-workloads/admin-documentation/openpbs-hooks.md) - Understand and configure OpenPBS hooks used by IDEA

## Key Administrative Capabilities

### Budget Management

The Submit Job page now includes a Budget tab that provides visibility into project budget consumption. This feature helps users understand their spending limits before submitting jobs. Administrators can configure budgets for projects to control costs and prevent overspending. See [Set Up Budget Per Project](../../best-practices/budget/set-up-budget-per-project.md) for details.
The Submit Job page now includes a Budget tab that provides visibility into project budget consumption. This feature helps users understand their spending limits before submitting jobs. Administrators can configure budgets for projects to control costs and prevent overspending. See [Set Up Budget Per Project](https://github.com/cfs-energy/idea/tree/main/docs/modules/best-practices/budget/set-up-budget-per-project.md) for details.

### Job Submission Forms

Expand Down
2 changes: 0 additions & 2 deletions docs/modules/virtual-desktop-interfaces/admin-documentation/sessions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ Click "**Actions**" button to get a list of all available options
Force option will be executed even if there is an active connection on the desktop. Use regular option If you want to be on the safe side and avoid disconnecting users.
{% endhint %}

<figure><img src="../../../.gitbook/assets/mods_vdi_admin_sessions_view.webp" alt=""><figcaption><p>View all virtual desktop sessions for your entire organization</p></figcaption></figure>

Administrators can view and manage all desktop sessions across users and projects from this view. To manage sessions, select one or multiple sessions and click "**Actions**" to see all available operations:

* **Launch DCV Session**: Open the selected session in DCV viewer
Expand Down