Skip to content

Commit e383cb5

Browse files
committed
adding more definition around the scope of the FE config
1 parent 1391b3b commit e383cb5

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

docs/backendconfig/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,10 @@ ES_REFRESH=<"wait_for"|"false">
498498
LOGGERS_CONFIG_FILE="loggers.json"
499499
DATASET_TYPES_FILE="datasetTypes.json"
500500
PROPOSAL_TYPES_FILE="proposalTypes.json"
501+
502+
FRONTEND_CONFIG_FILE="src/config/frontend.config.json"
503+
FRONTEND_THEME_FILE="src/config/frontend.theme.json"
504+
501505
```
502506
### How to configure to connect the backend to other services
503507
In [scicatlive](https://www.scicatproject.org/scicatlive/latest/services/backend/) you find documentation on how to integrate your SciCat system with services providing identities, (e.g. KeyCloak) and authentication (OpenLDAP).

docs/frontendconfig/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Frontend configuration
22

3-
In only two json files SciCat's frontend configuration is managed, both as part of the backend configuration:
3+
SciCat's frontend configuration is managed in two configuration file, both served through the backend configuration:
44

5-
1. [frontend.config.json](https://github.com/SciCatProject/scicat-backend-next/blob/master/src/config/frontend.config.json) and
6-
2. [frontend.theme.json](https://github.com/SciCatProject/scicat-backend-next/blob/master/src/config/frontend.theme.json)
5+
1. [frontend.config.json](https://github.com/SciCatProject/backend/blob/master/src/config/frontend.config.json) defines the setup of the UI componets.
6+
2. [frontend.theme.json](https://github.com/SciCatProject/backend/blob/master/src/config/frontend.theme.json) defines the theming (color, font color etc) of the UI components.
7+
8+
The two frontend configs are served through the backend API so that it can be updated with ease. Adding these configs to the frontend would require a build step everytime the configuration file changed. To find out how to add the frontend configuration files to the backend please see [here](../backendconfig/index.md/#central-configuration-of-backend-env)
9+
10+
711

8-
Please write about
9-
- Why the frontend config is in the backend config?
10-
- What the scope is of these two files?
11-
- Please provide code snippets examples for enabling/disabling buttons. Add ideally screenshots.
1212

1313
# Default List & Filter Configuration Pattern - Frontend Configuration Guide
1414

0 commit comments

Comments
 (0)