DSD-DBS · MoritzWeber0 · Oct 9, 2024 · Oct 9, 2024
@@ -26,7 +26,7 @@ updates:
     directory: '/'
     schedule:
       interval: 'daily'
-  # Github Actions
+  # GitHub Actions
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:

@@ -110,7 +110,7 @@ options can be changed at any time later:
 > Currently, we only provide amd64 images. If you want to run the
 > application on arm64, you need to build the images yourself (option 3 or 4).
 
-1. Fetch management portal and session images from Github (without
+1. Fetch management portal and session images from GitHub (without
    TeamForCapella support). This option is recommended for the first
    deployment.
 
@@ -120,7 +120,7 @@ options can be changed at any time later:
    DEVELOPMENT_MODE=1 make helm-deploy open
    ```
 
-1. Build management portal images and fetch session images from Github (without
+1. Build management portal images and fetch session images from GitHub (without
    initial TeamForCapella support)
 
    ```zsh
@@ -171,7 +171,7 @@ dashboard, you can run the following command:
 make dashboard
 ```
 
-If something goes wrong, please open an issue on Github.
+If something goes wrong, please open an issue on GitHub.
 
 To clean up the environment, run:
 

@@ -23,7 +23,7 @@ class SecretReferenceVolume(Volume):
 
 @dataclasses.dataclass
 class PersistentVolume(Volume):
-    """An persistent volume that is mounted into the container."""
+    """A persistent volume that is mounted into the container."""
 
     volume_name: str
 

@@ -197,7 +197,7 @@ def test_validate_session_token_without_token_cookie(
     client: testclient.TestClient,
     session: sessions_models.DatabaseSession,
 ):
-    """Test that an request without cookie is declined during validation"""
+    """Test that a request without a cookie is declined during validation"""
 
     response = client.post(f"/api/v1/sessions/{session.id}/tokens/validate")
 

@@ -35,7 +35,7 @@ required for the following steps.
 
     ![Create client - Step 1](./create-client-1.png)
 
-1.  In **Capability config** modify the the default values as follows:
+1.  In **Capability config** modify the default values as follows:
 
     1. Enable **Client Authentication**
     1. Disable **Direct access grants**

@@ -6,7 +6,7 @@
 The Collaboration Manager repository contains a few tools that may come in
 handy when you're an administrator of a Collaboration Manager setup.
 
-The CLI (Command Line Interface) tool allows you to backup and restore user's
+The CLI (Command Line Interface) tool allows you to back up and restore user's
 workspaces.
 
 For the tools to work you'll need access to the Kubernetes cluster the

@@ -97,8 +97,8 @@ future.
 The minimum required resources are 3
 [Kubernetes CPU cores](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu)
 and around 2,5GiB of memory for the management platform. Depending on the load,
-the instance can scale up and is limited to 10 Kubernetes CPU cores cores and
-~8GiB of memory.
+the instance can scale up and is limited to 10 Kubernetes CPU cores and ~8GiB
+of memory.
 
 Each session requires a minimum of 0.4 Kubernetes CPU cores and 1.6Gi of
 memory. A session can scale up until it reaches 2 Kubernetes CPU cores and 6Gi
@@ -155,10 +155,10 @@ Verify that `helm` is working by executing the command:
 helm version
 ```
 
-## Step 5: Clone the Github Repository
+## Step 5: Clone the GitHub Repository
 
 Navigate to a persistent location on your server, e.g. `/opt`. Then clone the
-Github repository by running:
+GitHub repository by running:
 
 ```zsh
 git clone https://github.com/DSD-DBS/capella-collab-manager.git
@@ -214,7 +214,7 @@ have to change it to a more secure password:
 
 1. Open <http://localhost:8080/guacamole/> and login with `guacadmin` /
    `guacadmin`.
-1. Click on the `guacadmin` user at the top-right corner of the screen, then
+1. Click on the `guacadmin` user in the top-right corner of the screen, then
    select "Settings".
 1. Select the tab "Preferences"
 1. In the "Change password" section, enter `guacadmin` as current password.

@@ -102,8 +102,8 @@ the log level **INFO** and the HTTP method **POST**.
 ![Operations Example](./operations_example.png){:style="width:500px"}
 
 Theoretically, you could achieve the same result by changing two line contains
-operations, but it's inefficient and you have to use the exact format as in the
-log message.
+operations, but it's inefficient, and you have to use the exact format as in
+the log message.
 
 ![Operations Example without Logfmt](./operations_example_bad.png){:style="width:400px"}
 

@@ -30,8 +30,8 @@ Gitlab, are not available.
         - **Gitlab**: Only works with [Gitlab](https://about.gitlab.com/)
           instances (self-hosted / SaaS). With Gitlab, the diagram cache
           integration can be used.
-        - **Github**: Works with the public [Github](https://github.com/)
-          instance. With Github, the diagram cache integration can be used.
+        - **GitHub**: Works with the public [GitHub](https://github.com/)
+          instance. With GitHub, the diagram cache integration can be used.
     1. **Name**: Any name to identify the instance
     1. **Instance base URL**: The base URL of the instance, e.g.,
        `https://gitlab.com`. For more information, see
@@ -40,8 +40,8 @@ Gitlab, are not available.
         - **Gitlab**: The API URL to the
           [Gitlab REST API](https://docs.gitlab.com/ee/api/rest/). In most of
           the cases: `{base_url}/api/v4`, e.g., `https://gitlab.com/api/v4`.
-        - **Github**: The API URL to the
-          [Github REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28).
+        - **GitHub**: The API URL to the
+          [GitHub REST API](https://docs.github.com/en/rest?apiVersion=2022-11-28).
           The url is `https://api.github.com`.
 
 !!! warning

@@ -40,7 +40,7 @@
 1. Click on `Create`
 1. Enable the `pure::variants` integration and additional integrations if
    applicable.
-1. Add tool versions (if using `Capella + pure::variants`, please use the the
+1. Add tool versions (if using `Capella + pure::variants`, please use the
    Capella version for a proper matching with the TeamForCapella server
    version.)
 1. Add tool natures if applicable. If not tool nature is applicable, use a

@@ -39,7 +39,7 @@
 1.  Create a new session with the new Capella version.
 1.  In your persistent workspace, execute the following steps:
 
-    1. Right click on the model in your workspace.
+    1. Right-click on the model in your workspace.
     1. Select `Migration` and `Migrate Project toward current version`
        ![Migrate Capella model](../../user/tools/capella/migration/migrate-capella-model.png)
     1. A backup is not required as the latest version should still be available

@@ -175,7 +175,7 @@ variables can be used by the tool:
 In addition, the following variables are mounted if the TeamForCapella
 integration is enabled for the tool and the session type is `persistent`.
 
-For a explanation of those variables, refer to the
+For an explanation of those variables, refer to the
 [Capella Docker images documentation](https://dsd-dbs.github.io/capella-dockerimages/capella/t4c/base/#run-the-container).
 
 <table markdown="span" style=width:100%>
@@ -315,8 +315,7 @@ session tokens.
 
 ## Configuration examples
 
-To help you configuring your tools, we provide some examples for the tools,
-which we provide as part of our
+To help you configure your tools, we provide some examples as part of our
 [Capella Docker images repository](https://github.com/DSD-DBS/capella-dockerimages)
 
 === "Capella/Papyrus/Eclipse"

@@ -8,7 +8,7 @@
 We're sorry to see you go :sob: <br /> If you have any suggestions for us to
 improve, please share them with us. Either privately via <set@deutschebahn.com>
 or via a
-[Github issue](https://github.com/DSD-DBS/capella-collab-manager/issues).
+[GitHub issue](https://github.com/DSD-DBS/capella-collab-manager/issues).
 
 1.  If you want to uninstall the management portal, you can run the following
     comment:

@@ -103,7 +103,7 @@ Another example is working with the diagram cache of py-capellambse. The
 implementation of the Capella modelling tool `capellambse` uses Python and lets
 you read and write models. For more information have a look at the
 [documentation](https://dsd-dbs.github.io/py-capellambse/) or the
-[Github repository](https://github.com/DSD-DBS/py-capellambse).
+[GitHub repository](https://github.com/DSD-DBS/py-capellambse).
 
 ```python
 import capellambse

@@ -7,7 +7,7 @@ In order to make the whole backend more consistent, it is divided into
 different modules. This is to ensure that these can be outsourced without major
 impacts and that other modules can be added as "plugins".
 
-A extension has the following structure: <br>
+An extension has the following structure: <br>
 
 ```bash
 extension

@@ -5,7 +5,7 @@
 
 # Documentation
 
-It's important to have a good and up to date documentation for the
+It's important to have a good and up-to-date documentation for the
 Collaboration Manager. Documentation is an accessible way to share knowledge
 for developers, administrators and users. It can also be used by support teams
 to resolve issues more efficiently.
@@ -24,7 +24,7 @@ source files until the `make serve` process is terminated.
 
 When writing the documentation we are using title case in the
 [`Chicago Manual of Style`](https://en.wikipedia.org/wiki/Title_case#Chicago_Manual_of_Style).
-In addition personal names/ names of packages are written according to their
+In addition, personal names/ names of packages are written according to their
 documentation.
 
 ### Cross-linking between pages

@@ -43,7 +43,7 @@ uses flexbox on devices larger than `768px`.
 
 ### Example from the application
 
-If you want to see an code example of responsive design in the application, you
+If you want to see a code example of responsive design in the application, you
 can check the `HeaderComponent` HTML template:
 [frontend/src/app/general/header/header.component.html](https://github.com/DSD-DBS/capella-collab-manager/blob/main/frontend/src/app/general/header/header.component.html).
 You can search for `xl:` and play around with it.

@@ -91,7 +91,7 @@ The commit messages have to follow the
 [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#specification)
 specification.
 
-In general, we use pre-commit hooks to enforce coding standards. To setup the
+In general, we use pre-commit hooks to enforce coding standards. To set up the
 pre-commit hooks, please run the following commands:
 
 ```zsh

@@ -3,7 +3,7 @@
  ~ SPDX-License-Identifier: Apache-2.0
  -->
 
-To find out which resources are used in the cluster, you can install a the tool
+To find out which resources are used in the cluster, you can install the tool
 [`kube-capacity`](https://github.com/robscott/kube-capacity):
 
 ```zsh

@@ -9,7 +9,7 @@ To reduce the burden on our maintainers, all PRs must meet the following
 criteria before we start the review process. If the acceptance criteria are not
 met, please mark the PR as a draft.
 
--   All Github Action pipelines have to be green. If in individual cases the
+-   All GitHub Action pipelines have to be green. If in individual cases the
     pipeline cannot be fixed independently or the pipeline failure is unrelated
     to the PR, then this should be justified in a comment in the pull request.
 -   The adapted code was sensibly covered with tests. Codecov will indicate the

@@ -128,6 +128,6 @@ sections:
 
 If you don't find answer to your question on this documentation site please
 consider opening an
-[issue on Github](https://github.com/DSD-DBS/capella-collab-manager/issues) or
+[issue on GitHub](https://github.com/DSD-DBS/capella-collab-manager/issues) or
 extending the documentation with your own contribution via a
 [pull request](https://github.com/DSD-DBS/capella-collab-manager/pulls).
@@ -31,7 +31,7 @@
 1.  Select your project in the project overview.
 1.  On the right side you should now see user management options:
     ![User management](./manage-users.png)
-1.  Select the user you want do modify: <br>
+1.  Select the user you want to modify: <br>
     ![User modification](./modify-user.png)
 
     You can select from the following options:

@@ -30,5 +30,5 @@ can skip this step. Users can be added later at any time.
 
 ## Step 3: Add Models
 
-Please follow the model creation instructions to setup a model:
+Please follow the model creation instructions to set up a model:
 [Create a model](../models/create.md)
@@ -44,7 +44,7 @@ following options:
 
 If you chose option 1 or 2 in the last step, please read the
 `Link existing Git repository` part of this step. If you chose option 3 or 4,
-you can should read the `Link existing T4C repository` part.
+you should read the `Link existing T4C repository` part.
 
 ### Step 3.1 Link Existing Git Repository
 
@@ -105,7 +105,7 @@ This is an important step.
 
 Here, you can select the version and the model nature of your tool. If you
 don't select any version, the functionality will be restricted. You will not be
-able to setup backups or create read-only sessions.
+able to set up backups or create read-only sessions.
 
 If suitable for your project, select one of the latest versions of Capella.
 Older versions may be removed in the future. Make sure your model is up to date

@@ -24,7 +24,7 @@
     - One pipeline in the linked Git repository should not contain more than 20 jobs.
 
 1.  To set up the diagram cache, your administrator needs to add the Git API
-    URL of your Gitlab or Github instance to the collab manager. More
+    URL of your Gitlab or GitHub instance to the collab manager. More
     information [here](../../../../admin/settings/model-sources/git.md).
 1.  Link a Git repository to the model, for which you'd like to see the diagram
     cache.

@@ -6,7 +6,7 @@
 # Working with Git
 
 In this guide we explain how to use Git via Eclipse. When using Git we make
-changes _locally_ and push them to a _remote_ (Gitlab or Github mainly)
+changes _locally_ and push them to a _remote_ (Gitlab or GitHub mainly)
 repository. Here we explain how to get made changes to the remote repository so
 that collegues can see and review them.
 
@@ -41,21 +41,21 @@ locally.
 ## Switch Branches
 
 To collaborate it might be useful to work on different branches. Therefore,
-there are two ways to switch branches (to checkout existing ones or to create a
-new one).
+there are two ways to switch branches (to check out existing ones or to create
+a new one).
 
-Either you right click on the project name in the lower right corner, go to
+Either you right-click on the project name in the lower right corner, go to
 "Switch to" and then e.g. "New Branch"
 
 ![Step 4: Search for View](screenshots/switch-branch-v1.png)
 
-or you can right click on the project name in the project tree and then click
+or you can right-click on the project name in the project tree and then click
 "Team"> "Switch to" > "New Branch".
 
 ![Step 5: Search for View](screenshots/switch-branch-v2.png)
 
 In order to make the changes visible in your project tree and to see on which
-branch you are currently working on right click on the project name > "Close
+branch you are currently working on right-click on the project name > "Close
 Project" and then open the project again.
 
 ## Prepare to Commit - Stage Changes
@@ -97,7 +97,7 @@ changes (2).
 
 ![Step 7: Search for View](screenshots/staged-changes.png)
 
-If you already committed your changes you can right click on the Project >
+If you already committed your changes you can right-click on the Project >
 "Team" > "Push to Origin" in order to push your changes to the remote.
 
 If you have not commited yet and want to publish your changes and to share them
@@ -179,7 +179,7 @@ as they can not be merged in the seperate layers.
 In the synthesis view you can see the number of changes that happened. If you
 click on a specific change you can see in the Details (1) and also marked in
 blue on both models what changed and possibly how the current status in both
-models is. Then you can right click on the change in the synthesis view and
+models is. Then you can right-click on the change in the synthesis view and
 click "Apply change(s)" (2) and you can click "Ok" then. Afterwards make sure
 to Ctrl+S or File > Save to save the change made.
 
@@ -260,8 +260,8 @@ option.
 ![Step 10: Git Create Intermediate Branch](screenshots/create-merge-branch.png)
 
 After pushing your changes to the remote Git repository, open the remote
-project on Gitlab or Github. Then open a Merge request (Gitlab) or Pull request
-(Github) respectively and try merging your "merge-branch-name" branch into main
+project on Gitlab or GitHub. Then open a Merge request (Gitlab) or Pull request
+(GitHub) respectively and try merging your "merge-branch-name" branch into main
 (or the branch you wanted to push on before).
 
 You will now see whether the Merge request/ Pull request can be merged

@@ -21,7 +21,7 @@ A very nice set of videos, highly recommended to watch:
 You may find more Capella - related videos on the official channel:
 [EclipseCapella](https://www.youtube.com/c/EclipseCapella/videos)
 
-Also you can try out this
+Also, you can try out this
 [Capella Tutorial](https://esd.sutd.edu.sg/40014-capella-tutorial/index.html)
 
 ## More Advanced Topics

@@ -23,7 +23,7 @@
     [Change model metadata](../../../projects/models/metadata.md).
 1.  Create a new session with the new Capella version.
 1.  In your persistent workspace loaded, execute the following steps:
-    1.  Right click on the model in your workspace.
+    1.  Right-click on the model in your workspace.
     1.  Select `Migration` and `Migrate Project toward current version`
         ![Migrate Capella model](./migrate-capella-model.png)
     1.  A backup is recommended.

@@ -39,7 +39,7 @@ model lead (usually this role is allocated to lead architects / area owners).
 
     ![Connect to remote model](screenshots/step_2.png)
 
-1.  In the drop down select the repository you like to work on. In most cases
+1.  In the drop-down select the repository you like to work on. In most cases
     the repository and project name should match.
 1.  Click on `Test connection` and enter you username and the session token you
     received in the first step.