diff --git a/docs/docs/admin/troubleshooting.md b/docs/docs/admin/troubleshooting.md index 5e85be066..bb1952102 100644 --- a/docs/docs/admin/troubleshooting.md +++ b/docs/docs/admin/troubleshooting.md @@ -3,7 +3,7 @@ ~ SPDX-License-Identifier: Apache-2.0 --> -# Troubleshooting +# Administrator Troubleshooting ## Can't resolve registry diff --git a/docs/docs/development/troubleshooting.md b/docs/docs/development/troubleshooting.md index 845281ff9..89250877f 100644 --- a/docs/docs/development/troubleshooting.md +++ b/docs/docs/development/troubleshooting.md @@ -3,7 +3,7 @@ ~ SPDX-License-Identifier: Apache-2.0 --> -# Troubleshooting +# Development Troubleshooting ## The `k3d` Registry is Unreachable diff --git a/docs/docs/user/sessions/troubleshooting.md b/docs/docs/user/sessions/troubleshooting/index.md similarity index 54% rename from docs/docs/user/sessions/troubleshooting.md rename to docs/docs/user/sessions/troubleshooting/index.md index bc78b1713..790761509 100644 --- a/docs/docs/user/sessions/troubleshooting.md +++ b/docs/docs/user/sessions/troubleshooting/index.md @@ -3,7 +3,12 @@ ~ SPDX-License-Identifier: Apache-2.0 --> -??? question "My session window doesn't scale properly" +# Session Troubleshooting + + +??? question "My session window doesn't scale properly :material-link:" + + If you use a direct session connection via Guacamole, the window doesn't scale automatically after browser resizing. You can manually trigger a resize by @@ -12,7 +17,10 @@ Alternatively, you can use our internal session viewer, which comes with automatic scaling out of the box. -??? question "The session requests takes a long time" + +??? question "The session requests takes a long time :material-link:" + + If a session takes a few minutes to start, it means that you've reached a new node that doesn't have the requested tool installed (for load balancing reasons, @@ -21,25 +29,17 @@ or updates from the cluster operator. In both cases, we pull a new Docker image (which can be understood as a reinstallation of the tool) on demand. -??? question "I've minimized my window in Xpra and can't get it back" - - Just refresh the page in the browser. The window should appear again. + +??? question "I've minimized my window in Xpra and can't get it back :material-link:" -??? question "The clipboard doesn't work anymore." + - This is a known bug with our used `RDP`-server `xrdp`. `xrdp` maintains so - called `channels`, which are managed by the process `chansrv`. One channel - is `cliprdr`, which enables the clipboard feature. However, `chansrv` - doesn't terminate properly on session disconnects and `chansrv` doesn't - accept new connections. This leads to the fact that the clipboard doesn't - work anymore after a reconnect. The bug is tracked in the - [`xrdp` Github repository](https://github.com/neutrinolabs/xrdp/issues/1188) - and in [our Github repository](https://github.com/DSD-DBS/capella-dockerimages/issues/67). + Just refresh the page in the browser. The window should appear again. - The only solution for now: You have to terminate the existing session and - create a new session to get a working clipboard again. + +??? question "My read-only sessions shows 'Modelloading failed' :material-link:" -??? question "My read-only sessions shows 'Modelloading failed'" + This happens if the loading of one of the models fails. Please reach out your project lead. If you are project lead, please check @@ -50,19 +50,41 @@ If you have no success, please reach out your administrator. Administrators can see the logs of read-only sessions. -??? question "The TeamForCapella password doesn't work" + +??? question "The TeamForCapella password doesn't work :material-link:" + + Since we have released version 2, users have to use sessions passwords. More - information can be found [here](../tools/capella/teamforcapella/connect/index.md). + information can be found [here](../../tools/capella/teamforcapella/connect/index.md). If you have been added to a project recently while having a running session, please recreate your session to get a valid session password for the models of the required project. -??? question "I can't use the `Control` key for the secondary/right-click on macOS" +??? question "I can't use the `Control` key for the secondary/right-click on macOS :material-link:" + + Please use an external mouse or use the trackpad gesture (click with two fingers on the trackpad). The sessions run on Linux and the `Control` key can't be mapped properly via the remote desktop protocol. + + Alternatively, you can use the Xpra connection method instead of Guacamole. + + +??? question "My Xpra window doesn't react anymore :material-link:" + + + + If the Xpra window doesn't react anymore, a modal dialog in the background might block the main window. + + To identify a potential hidden dialog, double-click on the title-bar of the application in Xpra. Alternatively, you can minimize it: + ![Minimize Xpra window](./minimize-xpra.png) + + Then, drag the window around to see if there is any other modal dialog window. If you find one, close it. + + Another option is to refresh the browser tab. It will bring the hidden modal dialog into the foreground. + This step might take a bit longer. diff --git a/docs/docs/user/sessions/troubleshooting/minimize-xpra.png b/docs/docs/user/sessions/troubleshooting/minimize-xpra.png new file mode 100644 index 000000000..88221841b Binary files /dev/null and b/docs/docs/user/sessions/troubleshooting/minimize-xpra.png differ diff --git a/docs/docs/user/sessions/troubleshooting/minimize-xpra.png.license b/docs/docs/user/sessions/troubleshooting/minimize-xpra.png.license new file mode 100644 index 000000000..7ea22469b --- /dev/null +++ b/docs/docs/user/sessions/troubleshooting/minimize-xpra.png.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors +SPDX-License-Identifier: Apache-2.0 diff --git a/docs/docs/user/tools/capella/troubleshooting/close-projects.png b/docs/docs/user/tools/capella/troubleshooting/close-projects.png new file mode 100644 index 000000000..dabf3bec2 Binary files /dev/null and b/docs/docs/user/tools/capella/troubleshooting/close-projects.png differ diff --git a/docs/docs/user/tools/capella/troubleshooting/close-projects.png.license b/docs/docs/user/tools/capella/troubleshooting/close-projects.png.license new file mode 100644 index 000000000..7ea22469b --- /dev/null +++ b/docs/docs/user/tools/capella/troubleshooting/close-projects.png.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors +SPDX-License-Identifier: Apache-2.0 diff --git a/docs/docs/user/tools/capella/troubleshooting/confirm-close-projects.png b/docs/docs/user/tools/capella/troubleshooting/confirm-close-projects.png new file mode 100644 index 000000000..76d539fcd Binary files /dev/null and b/docs/docs/user/tools/capella/troubleshooting/confirm-close-projects.png differ diff --git a/docs/docs/user/tools/capella/troubleshooting/confirm-close-projects.png.license b/docs/docs/user/tools/capella/troubleshooting/confirm-close-projects.png.license new file mode 100644 index 000000000..7ea22469b --- /dev/null +++ b/docs/docs/user/tools/capella/troubleshooting/confirm-close-projects.png.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors +SPDX-License-Identifier: Apache-2.0 diff --git a/docs/docs/user/tools/capella/troubleshooting/index.md b/docs/docs/user/tools/capella/troubleshooting/index.md index 3067f244b..f48e95abf 100644 --- a/docs/docs/user/tools/capella/troubleshooting/index.md +++ b/docs/docs/user/tools/capella/troubleshooting/index.md @@ -5,7 +5,10 @@ # Capella Troubleshooting -!!! question "My Capella crashed. What should I do?" + +??? question "My Capella crashed. What should I do? :material-link:" + + Capella can crash for many different reasons. Many issues are issues with Eclipse Capella itself, so we try to escalate issues there. Bugs can be @@ -21,7 +24,10 @@ 1. You should now see the list of events and you can try to find an entry with a matching timestamp. -!!! question "The description editor doesn't load anymore" + +??? question "The description editor doesn't load anymore :material-link:" + + In some cases the description doesn't load anymore, is just a blank page, or looks like this: @@ -51,5 +57,37 @@ - End your session and request a new session in the Capella Collaboration Manager. - If none of these workarounds help, the only solution is to reset your workspace. Please contact your administrator for assistance. + + +??? question "My Capella is slow. What can I do? :material-link:" + + + + A slow Capella instance can have multiple reasons. Here are some common issues: + + 1. __Disable the automatic refresh in the Semantic Browser__ + + The automatic refresh of the Semantic Browser slows down Capella when connected to a TeamForCapella repository. + + By default, the Semantic Browser auto-refresh is enabled. You can disable it in each session using the button marked in the screenshot (red/right box). + After you've disabled the auto-refresh, you can manually refresh the Semantic Browser by clicking the refresh button (blue/left box): + ![Semantic Browser](./semantic-browser-autorefresh.png) + + When you want to save the option for all future sessions, disable it in the UI first and then close Capella to save the workbench state:
+ ![Exit Capella](./exit-capella.png){:style="width:300px"} + + 1. __Close all unrelated projects and tabs__ + + Navigate to the project explorer in Capella and right-click the project you want to work on. + Select "Close projects": + + ![Close projects](./close-projects.png){:style="width:300px"} + + Then, confirm the dialog: + + ![Confirm to close the projects](./confirm-close-projects.png) + + This will close all projects except the selected one. + + If none of those steps help, please reach out to your system administrator. diff --git a/docs/docs/user/tools/capella/troubleshooting/restart-capella.png b/docs/docs/user/tools/capella/troubleshooting/restart-capella.png new file mode 100644 index 000000000..54ad02721 Binary files /dev/null and b/docs/docs/user/tools/capella/troubleshooting/restart-capella.png differ diff --git a/docs/docs/user/tools/capella/troubleshooting/restart-capella.png.license b/docs/docs/user/tools/capella/troubleshooting/restart-capella.png.license new file mode 100644 index 000000000..7ea22469b --- /dev/null +++ b/docs/docs/user/tools/capella/troubleshooting/restart-capella.png.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors +SPDX-License-Identifier: Apache-2.0 diff --git a/docs/docs/user/tools/capella/troubleshooting/semantic-browser-autorefresh.png b/docs/docs/user/tools/capella/troubleshooting/semantic-browser-autorefresh.png new file mode 100644 index 000000000..ae4660b0e Binary files /dev/null and b/docs/docs/user/tools/capella/troubleshooting/semantic-browser-autorefresh.png differ diff --git a/docs/docs/user/tools/capella/troubleshooting/semantic-browser-autorefresh.png.license b/docs/docs/user/tools/capella/troubleshooting/semantic-browser-autorefresh.png.license new file mode 100644 index 000000000..7ea22469b --- /dev/null +++ b/docs/docs/user/tools/capella/troubleshooting/semantic-browser-autorefresh.png.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors +SPDX-License-Identifier: Apache-2.0 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e659f55ad..c626b4ff4 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -50,7 +50,7 @@ nav: - Terminate Session: user/sessions/terminate.md - Taking Screenshots: user/sessions/screenshots/index.md - Files Browser: user/sessions/files/index.md - - Troubleshooting: user/sessions/troubleshooting.md + - Troubleshooting: user/sessions/troubleshooting/index.md - Capella: - Introduction: user/tools/capella/introduction.md - Update a Capella Model to a Newer Version: user/tools/capella/migration/index.md