From 650dacbb38db0b7e1dd818e2d6bd0f76172efe95 Mon Sep 17 00:00:00 2001 From: prasadtalasila Date: Sun, 19 May 2024 08:49:11 +0200 Subject: [PATCH] Fixes codeclimate issues --- deploy/README.md | 2 +- deploy/docker/LOCALHOST.md | 1 - docker/README.md | 12 ++++++------ 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/deploy/README.md b/deploy/README.md index 2db40b56e..76ecead98 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -11,4 +11,4 @@ on all the supported Operating Systems. There are two installation scenarios each with a dedicated set of instructions: 1. Single user [localhost](./docker/LOCALHOST.md) -2. Multi-user [web application](./docker/SERVER.md) +1. Multi-user [web application](./docker/SERVER.md) diff --git a/deploy/docker/LOCALHOST.md b/deploy/docker/LOCALHOST.md index a2300bb8c..ec825ddd4 100644 --- a/deploy/docker/LOCALHOST.md +++ b/deploy/docker/LOCALHOST.md @@ -25,7 +25,6 @@ The default authorization configuration works for _gitlab.com_. If you desire to use locally hosted gitlab instance, please see the [client docs](../docs/admin/client/auth.md). - ## Configuration ### Docker Compose diff --git a/docker/README.md b/docker/README.md index b62f0c35e..a7c3faf20 100644 --- a/docker/README.md +++ b/docker/README.md @@ -2,7 +2,7 @@ Use of docker images is handy for developers. It is suggested that developers build the required images locally on their computer and -use them for development purposes. +use them for development purposes. This readme will explain the building and use of different docker files for development purposes. @@ -58,13 +58,13 @@ The configuration files to be updated are: 1. docker/.env please see [docker README](../deploy/docker/SERVER.md) for help with updating this config file) -2. docker/conf.local +1. docker/conf.local please see [server docs](../docs/admin/servers/auth.md) for help with updating this config file) -3. client/config/local.js +1. client/config/local.js please see [client config](../docs/admin/client/CLIENT.md) for help with updating this config file) -4. servers/lib/config/.env.default +1. servers/lib/config/.env.default please see [lib config](../docs/admin/servers/lib/LIB-MS.md) for help with updating this config file) @@ -96,7 +96,7 @@ docker compose -f compose.dev.yml down #terminate the application ### Access the Application The application will be accessible at: -_http://localhost_ from web browser. + from web browser. Sign in using your gitlab.com account. All the functionality of DTaaS should be available to you @@ -105,7 +105,7 @@ through the single page client now. ## Publish Docker Images Build and publish the docker images. This step is required only for -the publication of images to Docker Hub. +the publication of images to Docker Hub. :stop_sign: This publishing step is managed only by project maintainers. Regular developers can skip this step.