R&D Static Site Editor configuration file
Problem to solve
During a recent comment thread the future need for a configuration file was discussed: #214559 (comment 333724392)
We will soon require this feature as we want to allow users to configure where images are uploaded: #216641 (closed)
We should explore the best way to implement this configuration, how to read it and use it.
Required output
- Determine best way to define configuration options for the static site editor
- Determine best way to read and pass the configuration options to the the static site editor.
Example
The following is merely an example of how this could work:
- user defines a
.gitlab-sse.yml
file in the root of their project - user sets the upload directory path
- when editing a link on the production site the user is redirected to GitLab
- the configuration file is read from the repo (backend? frontend?) and merged with the SSE configuration defaults
- the SSE receives the config values and uses it
Considerations
- should the config be read by frontend/backend?
- should we validate the config? what do we do if it's invalid?
Edited by Jean du Plessis