Skip to content

Commit b8b3045

Browse files
some more changes
1 parent 280b08c commit b8b3045

File tree

3 files changed

+17
-13
lines changed

3 files changed

+17
-13
lines changed

docs/admin/admin-ui-setup/admin-ui-users.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Introduction
44

5-
The Run:ai UI allows the creation of Run:ai Users. Users are assigned levels of access to the to all aspects of the UI including submitting jobs on the cluster.
5+
The Run:ai UI allows the creation of Run:ai Users. Users are assigned levels of access to all aspects of the UI including submitting jobs on the cluster.
66

77
!!! Tip
88
It is possible to connect the Run:ai UI to the organization's directory and use single sign-on (SSO). This allows you to set Run:ai roles for users and groups from the organizational directory. For further information see [single sign-on configuration](../runai-setup/authentication/sso.md).
@@ -21,8 +21,8 @@ To create a new user:
2121
1. Login to the Run:ai UI at `company-name.run.ai`.
2222
2. Press the ![Tools and Settings](img/tools-and-settings.svg) icon, then select *Users*.
2323
3. Press *New user* and enter the user's email address, then press *Create*.
24-
4. Review the new user information and note the temporary password that has been assigned. You can opt to send the user an introductory email by selecting the checkbox.
25-
5. When complete, press *Done*.
24+
4. Review the new user information and note the temporary password that has been assigned. To send the user an introductory email, select the checkbox.
25+
5. Press *Done* when complete.
2626

2727
## Assigning access rules to users
2828

@@ -31,12 +31,12 @@ Once you have created the users you can assign them *Access rules*. This provide
3131
To add an *Access rule* to a user:
3232

3333
1. Select the user, then press *Access rules*, then press *+Access rule*.
34-
2. From the dropdown, select a *Role*.
35-
3. Press on the ![Scope](../../images/scope-icon.svg) and select a scope for the user.
34+
2. Select a *Role* from the dropdown.
35+
3. Press ![Scope](../../images/scope-icon.svg) then select a scope for the user. You can select multiple scopes.
3636
4. After selecting all the required scopes, press *Save rule*.
37-
5. If you want to add another rule, use the *+Access rule*.
38-
6. When all the rules are configured, press *Done*.
37+
5. To add another rule, use the *+Access rule*.
38+
6. Press *Done* when all the rules are configured.
3939

4040
### Roles and permissions
4141

42-
Roles provide a way to group permissions and assign them to either users or user groups. The role identifies the collection of permissions that administrators assign to users or user groups. Permissions define the actions that users can perform on the managed entities. The following table shows the default roles and permissions. For more information on roles, see [Role based access control](../runai-setup/access-control/rbac.md).
42+
Roles provide a way for administrators to group and identify collections of permissions that administrators assign to [subjects](../runai-setup/access-control/rbac.md#subjects). Permissions define the actions that can be performed on managed entities. The [Roles](../runai-setup/access-control/rbac.md#roles) table shows the default roles and permissions that come with the syste. See [Role based access control](../runai-setup/access-control/rbac.md) for more information.

docs/developer/cluster-api/submit-yaml.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,13 @@ spec:
106106
container: 8000
107107
```
108108

109-
1. Possible metrics can be `cpu-utilization`, `latency`, `throughput`, `concurrency`, `gpu-utilization`, `custom`. Different metrics may require additional [installations](../../admin/runai-setup/cluster-setup/cluster-prerequisites.md#inference) at the cluster level.
109+
1. Possible metrics can be `cpu-utilization`, `latency`, `throughput`, `concurrency`, `gpu-utilization`, `custom`. Different metrics may require additional [installations](../../admin/runai-setup/cluster-setup/cluster-prerequisites.md#inference) at the cluster level.
110110
2. Inference requires a port to receive requests.
111111

112112
## Suspend/Resume Interactive/Training Workload
113113

114-
to suspend trainig
114+
To suspend training:
115+
115116
```YAML
116117
apiVersion: run.ai/v2alpha1
117118
kind: TrainingWorkload #
@@ -128,9 +129,8 @@ spec:
128129
name:
129130
value: job-1 #
130131
```
131-
In order to suspend workload set `active` value to `false`
132-
To reume it back either set `active` value to `true` or remove it entirly.
133-
132+
In order to suspend the workload, set `active` to `false`.
133+
To resume the workload, either set `active` to `true` or remove it entirely.
134134

135135
## See Also
136136
* To understand how to connect to the inference workload, see [Inference Quickstart](../../Researcher/Walkthroughs/quickstart-inference.md).

mkdocs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,15 @@ theme:
1212
logo: images/RUNAI-LOGO-DIGITAL-2C_WP.svg
1313
features:
1414
- navigation.tabs
15+
- navigation.tabs.sticky
1516
- search.highlight
1617
- content.code.annotate
1718
- content.tabs.link
1819
- search.suggest
1920
- content.action.edit
21+
- navigation.top
22+
- toc.follow
23+
# - toc.integrate
2024
icon:
2125
edit: material/pencil
2226
view: material/eye

0 commit comments

Comments
 (0)