Skip to content

Commit af6593a

Browse files
committed
chore: wording
1 parent 55b0c91 commit af6593a

8 files changed

Lines changed: 24 additions & 28 deletions

File tree

docs/docs/10-users/60-compute/10-launcher.md

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

33
A launcher is a component of a project that defines how compute runs on RenkuLab. Each launcher combines an [Environment](environment) with a default [Resource Pools & Classes](resource-pools-and-classes) configuration.
44

5-
Renku supports two types of launcher:
5+
Renku supports two types of launchers:
66

77
1. **Session launcher:** launches an interactive, browser-based [Session](session) for coding and data exploration.
88
2. **Job launcher:** runs a non-interactive [Job](job) in the background when you submit it.
@@ -13,24 +13,22 @@ Renku supports two types of launcher:
1313

1414
A launcher contains:
1515

16-
1. an [Environment](environment), which defines the software installed in the run, and
17-
2. a default resource class (see [Resource Pools & Classes](resource-pools-and-classes)), which determines the compute resources available.
16+
1. an [Environment](environment), which defines the software packages and libraries used by the session or job, and
17+
2. a default resource class (see [Resource Pools & Classes](resource-pools-and-classes)), which determines the availabler compute resources.
1818

1919
For a Job launcher, you also configure a **job command** that defines what runs when the job is submitted.
2020

21-
Project's launchers are usable to everyone who can see the project. Anyone with access can launch a session or submit a job from a launcher configured in the project.
21+
Project's launchers are usable to everyone who can see the project. Anyone with access to the project can launch a session or submit a job from a launcher.
2222

2323
However, the sessions you launch and the jobs you submit are only accessible to you. They are not shared across users.
2424

2525
:::info
2626

27-
A third type of launcher, namely an **App Launchers**, will be available by October 2026.
27+
**App Launchers** will be available in October 2026.
2828

2929
:::
3030

31-
32-
3331
## Next steps
3432

3533
- To create an interactive session launcher, see [Add a session launcher to your project](session/guides/add-a-session-launcher-to-your-project).
36-
- To create a job launcher, see [Add a job launcher to your project](job/guides/create-a-job-launcher).
34+
- To create a job launcher, see [Add a job launcher to your project](job/guides/create-a-job-launcher).

docs/docs/10-users/60-compute/40-environment/guides/40-configure-frontends-for-a-session-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ In order to run a docker image in a session, Renku needs to know some informatio
44

55
In this section, you can see example configurations for commonly used images. If you build an image with one of these images as the base, then you can use this provided configuration to make that image run in RenkuLab. The information below can be copied and pasted into the **Advanced Settings** form for creating a **custom environment**.
66

7-
This page provides reference configurations to use in the **Advanced Settings** step of [How to use your own docker image for a Renku session](./use-your-own-docker-image-for-renku-session), specifically for images not built by Renku.
7+
This page provides reference configurations to use in the **Advanced Settings** step of [How to use your own docker image for a Renku session](./use-your-own-docker-image-for-renku-session), specifically for images not built by Renku.
88

99
<p class="image-container-l">
1010
![image.png](./use-your-own-docker-image-for-renku-session-40.png)
Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Session
22

3-
A Renku session is a running interactive run-time environment that can be used to do work on data and code.
3+
A Renku session is an interactive run-time environment that can be used to do work on data and code.
44

5-
A session is created by a **Session Launcher** (see [Launcher](../launcher)) and is a running instance of an [Environment](../environment). Inside a session, all of the project’s [Code repository](../../code/code-repository)s are cloned and [Data connector](../../data/data)s are mounted (as long as the user provided any required access credentials).
5+
A session is created by a **Session Launcher** (see [Launcher](../launcher)) and is a running instance of an [Environment](../environment). Inside a session, all of the project’s [Code repositories](../../code/code-repository) are cloned and [Data connectors](../../data/data) are mounted (as long as the user provided any required access credentials).
66

7-
A session has access to a certain amount of compute resources (CPU, GPU, RAM and storage). This is determined by the resource pool set on [Launchers](../launcher). For more information about compute resources, see [Resource Pools & Classes](../resource-pools-and-classes).
7+
A session has access to a certain amount of compute resources (CPU, GPU, RAM and storage). This is determined by the resource class set on the [Launcher](../launcher). For more information about compute resources, see [Resource Pools & Classes](../resource-pools-and-classes).
88

9-
The sessions you launch are always private to you.
9+
The sessions you launch are always private to you, but others with access to your project may launch their own instances
10+
of the session.

docs/docs/10-users/60-compute/60-job/guides/10-create-a-job-launcher.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ Job launchers do not support **global environments**. You must use **Create from
1010

1111
## Create a job launcher
1212

13-
1. In the **Sessions** section of the project page, click **+** to add a new launcher.
13+
1. In the **Launchers** section of the project page, click **+** to add a new launcher.
1414

1515
<p class="image-container-l">
1616
![JobLauncher](./job-creation-10.png)
1717
</p>
1818

1919
2. In the **Select the type of launcher to create** modal, choose **Job**.
2020

21-
<p class="image-container-l">
21+
<p class="image-container-m">
2222
![JobLauncher](./job-creation-20.png)
2323
</p>
2424

2525
3. Choose and configure an **environment**:
2626
- **Create from code** — Renku builds an environment from a code repository (for example, one with an `environment.yml` or `requirements.txt`). See [How to create an environment with custom packages installed](../../environment/guides/create-environment-with-custom-packages-installed).
27-
- **Custom image** — use your own Docker image. See [How to use your own docker image for a Renku session](../../environment/guides/use-your-own-docker-image-for-renku-session).
27+
- **External environment** — use your own Docker image. See [How to use your own docker image for a Renku session](../../environment/guides/use-your-own-docker-image-for-renku-session).
2828

29-
<p class="image-container-l">
29+
<p class="image-container-m">
3030
![JobLauncher](./job-creation-30.png)
3131
</p>
3232

docs/docs/10-users/60-compute/60-job/guides/20-submit-a-job.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ See [How to configure a session secret](../../guides/configure-session-secret) f
2222

2323
2. Review the environment summary in the **Review and submit job** modal.
2424

25-
<p class="image-container-l">
25+
<p class="image-container-m">
2626
![JobLauncher](./job-submission-20.png)
2727
</p>
2828

29-
3. Enter a **Submission ID**, that is a short unique name for this job run (for example, `run-a1b2c3`). Renku suggests one automatically; you can edit it.
29+
3. Enter a **Submission ID**, that is a short unique name for this job run (for example, `run-a1b2c3`). Renku suggests one automatically but you can edit it before submitting the job.
3030

3131
The submission ID must:
3232
- Start with a lowercase letter
@@ -44,7 +44,7 @@ See [How to configure a session secret](../../guides/configure-session-secret) f
4444
7. Click **Submit job**.
4545

4646
<p class="image-container-l">
47-
![JobLauncher](./job-submission-30.png)
47+
![JobLauncher](job-submission-30.png)
4848
</p>
4949

5050
You can submit multiple jobs from the same launcher at the same time. Each job must have its own submission ID.

docs/docs/10-users/60-compute/60-job/guides/30-monitor-cancel-and-dismiss-jobs.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Your active and recent jobs appear in several places:
88

99
- **Under the job launcher** on the project page — each row shows the submission ID and status
1010
- **In the launcher side panel** — open the launcher to see **Your submitted jobs**
11-
- **On your dashboard** — jobs are listed alongside interactive sessions
11+
- **On your dashboard** — jobs are listed just below interactive sessions
1212

1313
<p class="image-container-l">
1414
![JobLauncher](./job-monitoring-10.png)
@@ -32,8 +32,6 @@ While a job is **Starting**, **Running**, **Completed**, or **Errored**, click *
3232
![JobLauncher](./job-monitoring-20.png)
3333
</p>
3434

35-
<!-- TODO: screenshot monitor-cancel-and-dismiss-jobs-30.png — View logs for a running job -->
36-
3735
Logs are available for 24 hours or until you dismiss the job.
3836

3937
## Cancel a running job
@@ -55,7 +53,6 @@ When a job has **Completed** or **Errored**, click **Dismiss** to remove it from
5553
![JobLauncher](./job-monitoring-40.png)
5654
</p>
5755

58-
5956
:::warning
6057

6158
Dismissing a job is permanent. You will not be able to view that job or its logs again in RenkuLab after dismissing it.

docs/docs/10-users/60-compute/60-job/index.md

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

33
A Renku job is a non-interactive run that executes a command in the background using a project's [Environment](../environment) and compute resources.
44

5-
A job is submitted from a **Job launcher** (see [Launcher](../launcher)) and runs without a browser-based interface. Inside the job, all of the project's [Code repository](../../code/code-repository)s are cloned and [Data connector](../../data/data)s are mounted, as long as you provided any required access credentials when submitting.
5+
A job is submitted from a **Job launcher** (see [Launcher](../launcher)) and runs without a browser-based interface. Inside the job, all of the project's [Code repositories](../../code/code-repository) are cloned and [Data connectors](../../data/data) are mounted, as long as you provided any required access credentials when submitting.
66

77
Each job submission is identified by a **submission ID** — a short name you choose (or accept from the auto-generated default) that must be unique among your jobs on that launcher. You use the submission ID to tell jobs apart when several are running at once.
88

@@ -14,11 +14,11 @@ The jobs you submit are always private to you. Jobs are not shared between users
1414

1515
A job moves through states such as **Starting**, **Running**, **Completed**, and **Errored**. While a job is starting or running, you can view its logs or cancel it. When a job has completed or errored, you can view its logs and then **Dismiss** it to remove it from your project and dashboard.
1616

17-
Dismissing a job permanently removes it from the RenkuLab interface. You will not be able to reopen its logs after dismissing it.
17+
Dismissing a job permanently removes it from RenkuLab. You will not be able to reopen its logs after dismissing it.
1818

1919
:::note
2020

21-
Completed and errored jobs are typically removed automatically after about 24 hours if you have not dismissed them. This retention period may change in the future.
21+
Completed and errored jobs are typically removed automatically after 24 hours if you have not dismissed them.
2222

2323
:::
2424

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# App
22

3-
Renku apps will be available by October 2026. In the meantime, you can create dashboards for your Renku projects as described in the How-To guides in this section of the documentation.
3+
Renku apps will be available by October 2026. In the meantime, you can create dashboards for your Renku projects as described in the How-To guides in this section of the documentation.

0 commit comments

Comments
 (0)