Merge pull request #276 from bci-oss/fix-documentation

Fix documentation

Author: atextor

.github/workflows/codeql-scanning.yml

@@ -14,7 +14,7 @@ on:
 jobs:
   analyze:
     name: Analyze
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     permissions:
       actions: read
       contents: read

.github/workflows/push_request_check.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   build:
     name: Check if passes all requirements
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
       - name: Checkout project

.github/workflows/tagged_release.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ macos-12, windows-latest, ubuntu-20.04 ]
+        os: [ macos-12, windows-latest, ubuntu-latest ]
 
     steps:
       - name: Checkout project
@@ -44,25 +44,25 @@ jobs:
           cache-dependency-path: '**/package-lock.json'
 
       - name: Set versions
-        if: matrix.os == 'ubuntu-20.04'
+        if: matrix.os == 'ubuntu-latest'
         run: |
           release_version=${{ github.event.inputs.release_version }}
           release_branch_name=${release_version%.*}.x
           echo "release_branch_name=$release_branch_name" >> $GITHUB_ENV
 
       - name: Get glibc version
-        if: matrix.os == 'ubuntu-20.04'
+        if: matrix.os == 'ubuntu-latest'
         run: |
           version=$(ldd --version | head -n 1 | awk '{print $NF}')
           echo "GLIBC_VERSION=$version" >> $GITHUB_ENV
           echo "::set-output name=glibc_version::$version"
 
       - name: Set antora version
-        if: matrix.os == 'ubuntu-20.04'
+        if: matrix.os == 'ubuntu-latest'
         run: yq eval -i '.version = "${{ github.event.inputs.release_version }}"' documentation/ame-guide/antora.yml
 
       - name: Commit version changes and push to upstream repository
-        if: matrix.os == 'ubuntu-20.04'
+        if: matrix.os == 'ubuntu-latest'
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "github-actions"
@@ -106,7 +106,7 @@ jobs:
           chmod 755 backend/ame-backend-${{ github.event.inputs.release_version }}-mac
 
       - name: Download aspect model service into project (Linux)
-        if: matrix.os == 'ubuntu-20.04'
+        if: matrix.os == 'ubuntu-latest'
         run: |
           mkdir backend
 
@@ -175,7 +175,7 @@ jobs:
         working-directory: core
 
       - name: Set app version (Unix)
-        if: matrix.os == 'macos-12' || matrix.os == 'ubuntu-20.04'
+        if: matrix.os == 'macos-12' || matrix.os == 'ubuntu-latest'
         run: npm version ${{ github.event.inputs.release_version }}
         working-directory: core
 
@@ -190,7 +190,7 @@ jobs:
         working-directory: core
 
       - name: Build electron app (Linux)
-        if: matrix.os == 'ubuntu-20.04'
+        if: matrix.os == 'ubuntu-latest'
         run: |
           npm run build:linux:prod
           mv electron/aspect-model-editor-v${{ github.event.inputs.release_version }}-linux.tar.gz electron/aspect-model-editor-v${{ github.event.inputs.release_version }}-linux-glibc-v${{ env.GLIBC_VERSION }}.tar.gz
@@ -224,7 +224,7 @@ jobs:
 
       # Release Linux executables
       - name: Create GitHub release (Linux)
-        if: ${{ (matrix.os == 'ubuntu-20.04') && (!contains( github.ref, '-rc' )) }}
+        if: ${{ (matrix.os == 'ubuntu-latest') && (!contains( github.ref, '-rc' )) }}
         uses: svenstaro/upload-release-action@latest
         with:
           overwrite: true
@@ -234,7 +234,7 @@ jobs:
           tag: v${{ github.event.inputs.release_version }}
 
       - name: Create GitHub pre-release (Linux)
-        if: ${{ (matrix.os == 'ubuntu-20.04') && (contains( github.ref, '-rc' )) }}
+        if: ${{ (matrix.os == 'ubuntu-latest') && (contains( github.ref, '-rc' )) }}
         uses: svenstaro/upload-release-action@latest
         with:
           overwrite: true

documentation/ame-guide/modules/ROOT/pages/installation.adoc

@@ -114,11 +114,11 @@ In case you have already an older version, uninstall it first and then install t
 
 == Install the Aspect Model Editor on Mac
 
-=== Step 1: Download the .app File ==
+=== Step 1: Download the .app File
 
 * Navigate to the released assets section and download the `.app` file.
 
-=== Step 2: Move the .app File to the Applications Folder ==
+=== Step 2: Move the .app File to the Applications Folder
 
 * Find the downloaded `.app` file on your computer.
 * Drag and drop it into your Applications folder.

documentation/ame-guide/modules/ROOT/pages/namespace/workspace.adoc

@@ -6,9 +6,10 @@ The workspace is a simple folder structure on your local machine.
 By default, the Aspect Model Editor file directory is located at following path:
 
 * `+C:\Users\<YOUR-USER-NAME>\aspect-model-editor+` (on Windows)
-* `+/Users/<YOUR-USER-NAME>/aspect-model-editor+` (on Mac or Linux)
+* `+/Users/<YOUR-USER-NAME>/aspect-model-editor+` (on MacOs )
+* `+/home/<YOUR-USER-NAME>/aspect-model-editor+` (on Linux)
 
-On your local file directory, you can manually add, edit, and delete the folder structure for all your Aspect Models.  
+On your local file directory, you can manually add, edit, and delete the folder structure for all your Aspect Models.
 
 Of course, this is also possible with the Aspect Model Editor. The same folder structure is displayed in the xref:getting-started/ui-overview.adoc#workspace-sidebar[Workspace sidebar].