diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 7c70c0f5a..b1205bba7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -29,4 +29,4 @@ jobs: - name: show contents of compiled docs run: | - ls site + ls -R site diff --git a/STATUS.md b/STATUS.md index 3b801d3aa..9de258f0c 100644 --- a/STATUS.md +++ b/STATUS.md @@ -1,17 +1,14 @@ # Project Quality Checks [![Maintainability](https://api.codeclimate.com/v1/badges/b19dba8a600e5ab6b49f/maintainability)](https://codeclimate.com/github/INTO-CPS-Association/DTaaS/maintainability) - [![codecov](https://codecov.io/gh/INTO-CPS-Association/DTaaS/branch/feature/distributed-demo/graph/badge.svg?token=18F1J5IIO5)](https://codecov.io/gh/INTO-CPS-Association/DTaaS) -[![Client CI](https://github.com/into-cps-association/dtaas/actions/workflows/client.yml/badge.svg)](https://github.com/into-cps-association/dtaas/actions/workflows/client.yml/badge.svg) - -[![Server CI](https://github.com/into-cps-association/dtaas/actions/workflows/server.yml/badge.svg)](https://github.com/into-cps-association/dtaas/actions/workflows/server.yml/badge.svg) +[![Client](https://github.com/into-cps-association/dtaas/actions/workflows/client.yml/badge.svg)](https://github.com/into-cps-association/dtaas/actions/workflows/client.yml/badge.svg) +[![Library Microservice](https://github.com/into-cps-association/dtaas/actions/workflows/lib-ms.yml/badge.svg)](https://github.com/into-cps-association/dtaas/actions/workflows/lib-ms.yml/badge.svg) +[![DT Runner](https://github.com/into-cps-association/dtaas/actions/workflows/runner.yml/badge.svg)](https://github.com/into-cps-association/dtaas/actions/workflows/runner.yml/badge.svg) +[![Documentation](https://github.com/into-cps-association/dtaas/actions/workflows/docs.yml/badge.svg)](https://github.com/into-cps-association/dtaas/actions/workflows/docs.yml/badge.svg) [![Contributors](https://img.shields.io/github/contributors/INTO-CPS-Association/DTaaS)](https://github.com/INTO-CPS-Association/DTaaS/graphs/contributors) - [![Latest Commit](https://img.shields.io/github/last-commit/INTO-CPS-Association/DTaaS)](https://github.com/INTO-CPS-Association/DTaaS/commits/feature/distributed-demo) [![INTO-CPS Association](https://img.shields.io/badge/INTO_CPS_Association-white)](https://into-cps.org/) - - diff --git a/docs/admin/client/auth.md b/docs/admin/client/auth.md index 16d2546d8..2dcfc94f3 100644 --- a/docs/admin/client/auth.md +++ b/docs/admin/client/auth.md @@ -1,5 +1,5 @@ -# Setting up OAuth Authentication for the client website +# OAuth Authentication for React Website The react client website uses OAuth authentication protocol for user authentication. The PKCE authentication flow of OAuth protocol is used for the client website. The authentication has to be setup on a gitlab server. **An oauth application needs to be created on a gitlab instance under admin user**. Then all other users can use the same gitlab instance for oauth authentication. This means commercial gitlab.com can not be used for multi-user authentication system required by DTaaS. The simplest way to make this work is to setup OAuth application as [instance wide authentication type](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-an-instance-wide-application). diff --git a/docs/admin/services.md b/docs/admin/services.md index 998a467ba..741695e6b 100644 --- a/docs/admin/services.md +++ b/docs/admin/services.md @@ -1,4 +1,4 @@ -# :electric_plug: Third-party Services +# Third-party Services The DTaaS software platform uses third-party software services to provide enhanced value to users. diff --git a/docs/developer/index.md b/docs/developer/index.md index 217107f26..f4c436779 100644 --- a/docs/developer/index.md +++ b/docs/developer/index.md @@ -1,4 +1,4 @@ -# :technologist: Developers Guide +# Developers Guide This guide is to help developers get familiar with the project. Please see developer-specific diff --git a/docs/developer/system/architecture.md b/docs/developer/system/architecture.md index 656cf83f2..a6b38176b 100644 --- a/docs/developer/system/architecture.md +++ b/docs/developer/system/architecture.md @@ -108,8 +108,8 @@ identified in the system architecture is also available in the table. | System Component | Container(s) | |:---|:---| | Gateway | [Traefik Gateway](https://github.com/INTO-CPS-Association/DTaaS/tree/feature/distributed-demo/servers/config/gateway#the-gateway-server) | -| Unified Interface | [React Webapplication](./client.md) | -| Reusable Assets | [Library Microservice](./lib-ms.md) | +| Unified Interface | [React Webapplication](../client/client.md) | +| Reusable Assets | [Library Microservice](../servers/lib/lib-ms.md) | | Data | MQTT, InfluxDB, and RabbitMQ (not shown in the C4 Level 2 diagram) | | Visualization | InfluxDB (not shown in the C4 Level 2 diagram) | | DT Lifecycle | DT Lifecycle Manager and DT Configuration Validator | diff --git a/docs/developer/testing/intro.md b/docs/developer/testing/intro.md index dc13703d3..843b07f05 100644 --- a/docs/developer/testing/intro.md +++ b/docs/developer/testing/intro.md @@ -1,4 +1,4 @@ -# :eye: Testing +# Testing ## :question: Common Questions on Testing diff --git a/docs/index.md b/docs/index.md index fa9d9775d..4950a9b47 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# :factory: :left_right_arrow: :busts_in_silhouette: What is DTaaS +# What is DTaaS The Digital Twin as a Service (DTaaS) software platform is useful to **Build, Use and Share** digital twins (DTs). diff --git a/mkdocs-github.yml b/mkdocs-github.yml index 1ca477037..23e20f5d6 100644 --- a/mkdocs-github.yml +++ b/mkdocs-github.yml @@ -17,6 +17,7 @@ theme: nav: - Home: index.md - Admin: + - Authentication: admin/client/auth.md - Host Install: - Trial: admin/trial.md - Production: admin/host.md diff --git a/mkdocs.yml b/mkdocs.yml index a70406af2..072c4cd8f 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,6 +17,7 @@ theme: nav: - Home: index.md - Admin: + - Authentication: admin/client/auth.md - Host Install: - Trial: admin/trial.md - Production: admin/host.md