adds template for frontend configuration documentation #12
Conversation
LAShemilt
left a comment
LAShemilt
left a comment
There was a problem hiding this comment.
LGTM. I have actually used these docs to upgrade our deployment here at the Franklin. One thing I am not clear on is how to use the FRONTEND_CONFIG_FILE variable with the files mounted in a volume. Would we be able to give an example here?
| - Why the frontend config is in the backend config? | ||
| - What the scope is of these two files? | ||
| - Please provide code snippets examples for enabling/disabling buttons. Add ideally screenshots. | ||
|
|
There was a problem hiding this comment.
Could we add something about where to mount these files in the backend container - or point to this in SciCat live?
| This guide explains how to configure the List & Side-Panel Configuration Pattern used on the frontend. | ||
| It allows customizing how list-based components (e.g., datasets, proposals) display table columns, side-panel filters, and optional query conditions. | ||
|
|
||
| The configuration should be defined or mounted at the location specified by the environment variable `FRONTEND_CONFIG_FILE` (default: `src/config/frontend.config.json`). |
There was a problem hiding this comment.
is this for both documents - frontend.theme.json and frontend.config.json?
Also how does this work with the FRONTEND_CONFIG_FILE environment variable?
I am trying to use this:
env:
- FRONTEND_CONFIG_FILE: src/config/
....
volumes:
- frontend.config.json:/home/src/config/frontend.config.json
- frontened.theme.json:/home/src/config/frontend.theme.json
But it throws an error in the backend
There was a problem hiding this comment.
Also it seems we need a FRONTEND_THEME_CONFIG file as well. Perhaps we could include this in the docs?
3 participants
main update: add a folder for frontend config documentation
updating mkdocs.yaml (unfortunatly only after fetching upstream changes)
also (unrelated to frontend):
start of jobs documentation for operators.