fix codeclimate issues

adds gitlab tutorial for users

.codeclimate.yml

@@ -47,3 +47,8 @@ exclude_patterns:
   - "client/config/"
   - "deploy/config/client/env*.js"
   - "files/"
+  - "CODE_OF_CONDUCT.md"
+  - "CONTRIBUTING.md"
+  - "LICENSE.md"
+  - ".github/ISSUE_TEMPLATE/"
+  - "docs/developer/conduct.md"

docs/admin/gitlab/index.md

@@ -66,8 +66,7 @@ should be available at <https://foo.com/gitlab>.
 
 **NOTE**: The GitLab instance operates with the `dtaas-frontend` network, which
 requires the DTaaS server to be running before you start it. You may refer to secure
-installation scenarios
-(../overview.md) for the same.
+[installation scenarios](../overview.md) for the same.
 
 The commands to start and stop the instance are:
 

docs/admin/gitlab/runner.md

@@ -107,6 +107,9 @@ A list of advanced configuration options is provided on the
 You may use the following commands to start and stop the `gitlab-runner`
 container respectively, depending on your installation scenario:
 
+1. Go to the DTaaS home directory (`DTaaS_DIR`) and execute one of
+   the following commands.
+
 1. Localhost Installation
 
     ```bash

docs/developer/index.md

@@ -26,7 +26,7 @@ environment.
 
 ### DevContainers
 
-There is a [devcontainer configuration](.devcontainer/devcontainer.json)
+There is a devcontainer configuration (`.devcontainer/devcontainer.json`)
 for the project. Please use it to get a dockerized development environment.
 DevContainer is the easiest way to get started.
 
@@ -35,7 +35,7 @@ DevContainer is the easiest way to get started.
 The code base has been developed for most part on
 Ubuntu/Linux Operating System.Thus certain parts of the code base might
 have bugs when run on Windows. At the moment, only
-[runner](./servers/execution/runner/DEVELOPER.md) has problems running
+[runner](../user/servers/execution/runner/README.md) has problems running
 on non-Linux OS.
 
 The development environment can be installed by using the following

docs/user/digital-twins/devops/file-structure.md

@@ -48,18 +48,19 @@ looks like this:
 
 ```text
 hello_world/
-├── lifecycle/
+├── lifecycle/ (at least one lifecycle script)
 │   ├── clean
 │   ├── create
 │   ├── execute
 │   └── terminate
-├── .gitlab-ci.yml
-└── description.md
+├── .gitlab-ci.yml (Gitlab DevOps config for executing lifecycle scripts)
+└── description.md (optional but is recommended)
+└── README.md (optional but is recommended)
 ```
 
-The `lifecycle` directory contains four files - `clean`, `create`, `execute`
-and `terminate`, which are executable scripts. The `hello-world` example uses
-simple [BASH scripts](https://www.gnu.org/software/bash/).
+The `lifecycle` directory here contains four files - `clean`, `create`,
+`execute` and `terminate`, which are simple
+[BASH scripts](https://www.gnu.org/software/bash/).
 These correspond to stages in a digital twin's lifecycle.
 Further explanation of digital twin is available on
 [lifecycle stages](../lifecycle.md).

docs/user/gitlab/tutorial.md

@@ -0,0 +1,78 @@
+# Working with Gitlab
+
+The DTaaS relies on Gitlab for two purposes.
+
+1. OAuth2 authorisation service
+1. DevOps service
+
+The [admin](../../admin/overview.md) documentation covers
+the OAuth2 authorisation configuration.
+This guide covers the use of git commands and project structure
+for Gitlab DevOps service inside the DTaaS.
+
+## Preparation
+
+The first step is to create a gitlab project with *username*
+in gitlab user group named *dtaas*.
+
+![Gitlab project create](./create-repo.png)
+
+This user needs to have ownership permissions over the project.
+
+![Project ownership](./repo-ownership.png)
+
+## Git commands
+
+The usual git commands and workflows should be used. There are two ways to
+use Gitlab project as a remote git server.
+
+1. Over SSH using personal SSH key
+1. Over HTTPS using
+   [personal access tokens (PAT)](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)
+
+This tutorial shows use of PAT for working with Gitlab server.
+
+First step is to create PAT.
+
+![Create PAT](create-PAT.png)
+
+Copy this token and use it to clone the git repository.
+
+## Library Assets
+
+The Gitlab is used to store the reusable **Library**
+assets of all users.
+There is a [mandatory structure](../servers/lib/assets.md) for storing and
+using Library assets including digital twins. A properly initialised
+gitlab project should have the following structure.
+
+![Project structure](./user-repo.png)
+
+Please pay special attention to `.gitlab-ci.yml`. It must be a valid
+Gitlab DevOps configuration. You can also check
+[example repo](https://gitlab.com/dtaas/user1) for a sample structure.
+
+For example, with `PAT1` as PAT of
+`dtaas/user1` repository, the command to clone the repository is
+
+```sh
+$git clone https://user1:[email protected]/gitlab/dtaas/user1.git
+$cd user1
+```
+
+Add the required Library assets and then
+
+```sh
+$git push origin
+```
+
+## Next Steps
+
+Remember to have a [gitlab runner](../../admin/gitlab/runner.md) integrated
+with your project repository. There might already be some runners installed
+with your DTaaS application. You can check them on the runners page.
+In addition, you can install your
+[own runners](../../admin/gitlab/runner.md) integrated into your repository.
+
+Now, the [Digital Twins Preview](../digital-twins/devops/ui.md) can be used
+to access the DevOps features of the DTaaS platform.

mkdocs-github.yml

@@ -29,6 +29,7 @@ nav:
           - DevOps Preview:
               - Digital Twin Structure: user/digital-twins/devops/file-structure.md
               - User Interface: user/digital-twins/devops/ui.md
+      - Gitlab Tutorial: user/gitlab/tutorial.md
       - Runner: user/servers/execution/runner/README.md
       - Examples:
           - Overview: user/examples/index.md

mkdocs.yml

@@ -29,6 +29,7 @@ nav:
           - DevOps Preview:
               - Digital Twin Structure: user/digital-twins/devops/file-structure.md
               - User Interface: user/digital-twins/devops/ui.md
+      - Gitlab Tutorial: user/gitlab/tutorial.md
       - Runner: user/servers/execution/runner/README.md
       - Examples:
           - Overview: user/examples/index.md

servers/lib/DOCKER.md

@@ -66,11 +66,11 @@ apollo-path: '/lib'
 graphql-playground: 'true'
 
 git-repos:   #only used in git mode
-  - user1: 
+  - user1:
       repo-url: 'https://gitlab.com/dtaas/user1.git'
-  - user2: 
+  - user2:
       repo-url: 'https://gitlab.com/dtaas/user2.git'
-  - common: 
+  - common:
       repo-url: 'https://gitlab.com/dtaas/common.git'
 ```
 
@@ -97,11 +97,11 @@ A fragment of the config for `git` mode is:
 ```yaml
 ...
 git-repos:
-  - user1: 
+  - user1:
       repo-url: 'https://gitlab.com/dtaas/user1.git'
-  - user2: 
+  - user2:
       repo-url: 'https://gitlab.com/dtaas/user2.git'
-  - common: 
+  - common:
       repo-url: 'https://gitlab.com/dtaas/common.git'
 ```
 

servers/lib/README.md

@@ -50,11 +50,11 @@ apollo-path: '/lib'
 graphql-playground: 'true'
 
 git-repos:   #only used in git mode
-  - user1: 
+  - user1:
       repo-url: 'https://gitlab.com/dtaas/user1.git'
-  - user2: 
+  - user2:
       repo-url: 'https://gitlab.com/dtaas/user2.git'
-  - common: 
+  - common:
       repo-url: 'https://gitlab.com/dtaas/common.git'
 ```
 
@@ -80,11 +80,11 @@ A fragment of the config for `git` mode is:
 ```yaml
 ...
 git-repos:
-  - user1: 
+  - user1:
       repo-url: 'https://gitlab.com/dtaas/user1.git'
-  - user2: 
+  - user2:
       repo-url: 'https://gitlab.com/dtaas/user2.git'
-  - common: 
+  - common:
       repo-url: 'https://gitlab.com/dtaas/common.git'
 ```
 

servers/lib/config/libms.dev.yaml

@@ -10,5 +10,5 @@ git-repos:   #only used in git mode
       repo-url: 'https://gitlab.com/dtaas/user1.git'
   - user2: 
       repo-url: 'https://gitlab.com/dtaas/user2.git'
-  - common: 
+  - common:
       repo-url: 'https://gitlab.com/dtaas/common.git'

servers/lib/config/libms.yaml.default

@@ -10,5 +10,5 @@ git-repos:   #only used in git mode
       repo-url: 'https://gitlab.com/dtaas/user1.git'
   - user2: 
       repo-url: 'https://gitlab.com/dtaas/user2.git'
-  - common: 
+  - common:
       repo-url: 'https://gitlab.com/dtaas/common.git'