Skip to content

Commit

Permalink
Merge pull request #1029 from DSD-DBS/docs
Browse files Browse the repository at this point in the history
Update read-only session related docs
  • Loading branch information
MoritzWeber0 authored Sep 19, 2023
2 parents 85698f9 + b52f488 commit 935073c
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 28 deletions.
37 changes: 15 additions & 22 deletions docs/user/docs/sessions/request.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,21 @@

Please follow these steps to request a session:

1. Navigate to the `Workspaces` tab inside the web application.
1. Please select your preferred worspace type.
<!-- prettier-ignore -->
!!! Question "Which type should I use?"
Please have a look at [Session Types](types.md)

1. In case of read-only sessions, you have to select a project. Then, two more
fields appear where you can choose the revision (i.e. branch or tag) and
either the latest commit or complete commit history of the primary model of
this project. Instead of choosing a single branch, it is possible to click
the checkbox to mark that all branches should be downloaded.

1. Click the `Request session` button.
1. You should see the state of your request. It can take up to 2 minutes, until
the required resources can be assigned. In most of the cases this takes
under 30 seconds.
1. You should now see a success message. Please click on `Connect to Session`.
1. The session should appear in a new tab and Capella starts automatically.
1. Please follow the instructions (depends on the workflow of your project)
<!-- prettier-ignore -->
1. [Git](flows/git.md)
1. [TeamForCapella](flows/t4c.md)
1. Navigate to the `Projects` tab inside the web application, and select your
project.
1. In the project select a model tool and version in the "Read-only session"
section. Only tools and versions used in the project are shown.
1. Click the `Request a read-only session` button.
1. A popup will request you to select the models that are compatible with the
selected tool. Once you select a model, you get the option to select a
branch.
1. You have an option to create a "deep clone". Normally only the latest
version of a model is loaded. A deep clone will make all previous revisions
available. It will take longer to start the session.
1. Click the `Start session` button.
1. You're redirected to the `Sessions` tab.
1. Wait for your read-only session to become ready and open it with the
`Connect` button.

## Automatic session termination

Expand Down
2 changes: 1 addition & 1 deletion docs/user/docs/sessions/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ sessions. The same restrictions as with Capella sessions apply here.
### Readonly Capella/Papyrus Sessions

Readonly Sessions allow you to read information from models without consuming a
licence.
license.

<!-- prettier-ignore -->
!!! warning
Expand Down
4 changes: 2 additions & 2 deletions docs/user/docs/sessions/types/persistent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
<!-- prettier-ignore-start -->

1. To get started with a persistent session, you have to naviate to
`Workspaces`.
`Sessions`.
2. Please select the tool and the version you'd like to work with:
![Request a persistent session](screenshots/request-session.png)
![Request a persistent workspace](screenshots/request-session.png)
3. You should see your session listed under `Active sessions` on the right.
![Active sessions](screenshots/active-sessions.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/user/docs/sessions/types/read-only.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
If you have read-only project access, or you simply want to check the model
without risk of editing, you may start a read-only session.

To do so, select the project from the project overview and the model from the
project details where you want to start a read-only session, and click on the
`eye`-button.
To do so, select the project from the project overview and select the modeling
tool and version from the `Read-only session` section. Next, select the models
you want to load in your read-only session.

Starting read-only session may take a bit of time, depending on the size of the
model and the current load. After the request, the application will fetch the
Expand Down

0 comments on commit 935073c

Please sign in to comment.