From 3c3b42021cb4c05baf9654f1e39bf61f753d2136 Mon Sep 17 00:00:00 2001 From: Spencer Bliven Date: Tue, 22 Oct 2024 23:50:11 +0200 Subject: [PATCH] Fix broken links (#59) part 1 --- Development/v3.x/README.md | 8 ++++---- Development/v4.x/Login.md | 6 +++--- Development/v4.x/README.md | 4 ++-- Development/v4.x/overview.md | 5 ++--- Development/v4.x/testing.md | 6 ++++++ SUMMARY.md | 2 +- 6 files changed, 18 insertions(+), 13 deletions(-) create mode 100644 Development/v4.x/testing.md diff --git a/Development/v3.x/README.md b/Development/v3.x/README.md index 3f6ae5ad..63c43b7b 100644 --- a/Development/v3.x/README.md +++ b/Development/v3.x/README.md @@ -1,8 +1,8 @@ # SciCat Data Catalogue Developer Guide -This guide aims to help developers understand the overall structure of the software and therefore enables people to contribute to the development of the software. See also the [Overview in the Operator Manual](../Operator/) for a helicopter view of the involved components. +This guide aims to help developers understand the overall structure of the software and therefore enables people to contribute to the development of the software. See also the [Overview in the Operator Manual](../../Operator/) for a helicopter view of the involved components. -If you want to contribute to the software you should also read the [Contributing](../Development/Development_Methods.html) section, which among others links to the git workflow to be used. +If you want to contribute to the software you should also read the [Contributing](./Development_Methods.html) section, which among others links to the git workflow to be used. # Getting an development environment set up @@ -21,8 +21,8 @@ The most important part to understand is how loopback works, because it is the p ## Web Browser Client (Frontend) -* [Angular 9+](https://angular.io/) -* [Angular Material Widgets and Design](https://material.angular.io/) +* [Angular 9+](https://angular.io/) +* [Angular Material Widgets and Design](https://material.angular.io/) * [NGRX for State Management](https://ngrx.io/) * [Loopback SDK generator for Angular](https://github.com/mean-expert-official/loopback-sdk-builder) diff --git a/Development/v4.x/Login.md b/Development/v4.x/Login.md index cb630f93..0ca38c24 100644 --- a/Development/v4.x/Login.md +++ b/Development/v4.x/Login.md @@ -2,10 +2,10 @@ Two login routes are provided - for functional accounts and for AD/LDAP logins. -Loopback provides a UserIdentity for third party logins, (e.g. AD/LDAP, google, Twitter etc) +Loopback provides a UserIdentity for third party logins, (e.g. AD/LDAP, google, Twitter etc) A document is created in the db.UserIdentity collection. -The UserIdentity is fetched from MongoDB and stored in the ngrx store, (```store.user.userIdentity```) where +The UserIdentity is fetched from MongoDB and stored in the ngrx store, (```store.user.userIdentity```) where it is used to access e.g. email for job initiators. The login method needs to be defined in the client configuartion (environment file) usign the field `externalAuthEndpoint`. For example `externalAuthEndpoint: "/auth/msad"`. @@ -30,4 +30,4 @@ These users should be defined in a seperate secrets repo in a file called functi ``` ## OIDC -For OIDC integration, see the [OIDC](./OIDC.html) for details. +For OIDC integration, see the [OIDC](./OIDC.md) for details. diff --git a/Development/v4.x/README.md b/Development/v4.x/README.md index 0a8828b8..98cb3564 100644 --- a/Development/v4.x/README.md +++ b/Development/v4.x/README.md @@ -1,8 +1,8 @@ # SciCat Data Catalogue Developer Guide -This guide aims to help developers understand the overall structure of the software and therefore enables people to contribute to the development of the software. See also the [Overview in the Operator Manual](../Operator/) for a helicopter view of the involved components. +This guide aims to help developers understand the overall structure of the software and therefore enables people to contribute to the development of the software. See also the [Overview in the Operator Manual](../../Operator/) for a helicopter view of the involved components. -If you want to contribute to the software you should also read the [Contributing](../Development/Development_Methods.html) section, which among others links to the git workflow to be used. +If you want to contribute to the software you should also read the [Contributing](./contributing.md) section. # Getting an development environment set up diff --git a/Development/v4.x/overview.md b/Development/v4.x/overview.md index a3155bdc..9762b44b 100644 --- a/Development/v4.x/overview.md +++ b/Development/v4.x/overview.md @@ -25,7 +25,7 @@ Mode details are found in each individual page ### Running the backend The backend can be run as it is, provided that a number of environmental variables are defined. -For the list of the environment variables available please see the [Backend Configuration page](Documentation/v4.x/backend/configuration.md). +For the list of the environment variables available please see the [Backend Configuration page](backend/configuration.md). To start the backend is as simple as running the following command: ``` @@ -40,9 +40,8 @@ There are multiple type of tests that can be run on the backend: npm run tests ``` - api tests - These tests are defined in the `test` folder and tests the endpoint. + These tests are defined in the `test` folder and tests the endpoint. To run them use the command: ``` npm run test:api:mocha ``` - diff --git a/Development/v4.x/testing.md b/Development/v4.x/testing.md new file mode 100644 index 00000000..683e698d --- /dev/null +++ b/Development/v4.x/testing.md @@ -0,0 +1,6 @@ +# Testing + +See + +- [backend](backend/testing_backend.md) +- [frontend](frontend/testing_frontend.md) \ No newline at end of file diff --git a/SUMMARY.md b/SUMMARY.md index 44f2f741..8feb0a1b 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -60,7 +60,7 @@ - [Backend](Development/v4.x/backend/testing_backend.md) - [Instrument](Development/v4.x/backend/testing/instrument.md) - [User Authorization](Development/v4.x/backend/testing/user_authorization.md) - - [Frontend](Development/v4.x/frontend/testing.md) + - [Frontend](Development/v4.x/frontend/testing_frontend.md) - [Migration v3.x to v4.x](Development/v4.x/Migration.md) - [Documentation](Development/Documentation.md)