Skip to content

Commit

Permalink
Fixes broken links (INTO-CPS-Association#120)
Browse files Browse the repository at this point in the history
  - Fixes broken links in the docs
  - Updates workflow badges on STATUS.md
  • Loading branch information
prasadtalasila authored Sep 29, 2023
1 parent 3e1935e commit af6b338
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ jobs:

- name: show contents of compiled docs
run: |
ls site
ls -R site
11 changes: 4 additions & 7 deletions STATUS.md
Original file line number Diff line number Diff line change
@@ -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/)


2 changes: 1 addition & 1 deletion docs/admin/client/auth.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/services.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# :technologist: Developers Guide
# Developers Guide

This guide is to help developers get familiar with the project. Please see
developer-specific
Expand Down
4 changes: 2 additions & 2 deletions docs/developer/system/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/testing/intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# :eye: Testing
# Testing

## :question: Common Questions on Testing

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -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 <font color="orange"> **Build, Use and Share** </font> digital twins (DTs).
Expand Down
1 change: 1 addition & 0 deletions mkdocs-github.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit af6b338

Please sign in to comment.