Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Fix broken links #60

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Development/v3.x/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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)

Expand Down
6 changes: 3 additions & 3 deletions Development/v4.x/Login.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"`.
Expand All @@ -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.
4 changes: 2 additions & 2 deletions Development/v4.x/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
5 changes: 2 additions & 3 deletions Development/v4.x/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
Expand All @@ -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
```

6 changes: 6 additions & 0 deletions Development/v4.x/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Testing

See

- [backend](backend/testing_backend.md)
- [frontend](frontend/testing_frontend.md)
2 changes: 1 addition & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<!-- * [API Documentation](https://scicatproject.github.io/api/) -->