Skip to content

Conversation

@omkar-ethz
Copy link
Member

Update docs for supportEmail frontend config added in SciCatProject/frontend#1933

omkar-ethz added a commit to SciCatProject/frontend that referenced this pull request Jul 10, 2025
…rtEmail (#1933)

## Description
This PR adds an environment variable `supportEmail`. If set, a card
"Questions or issues" is added in the `/help` page like so:
![Screenshot from 2025-07-08
14-55-16](https://github.com/user-attachments/assets/789f4e20-ee0f-49b3-badf-2ee4f54666e9)

## Motivation
Currently, users had no way to look up a contact email in case of issues
or questions. This PR adds it via a configurable `supportEmail` env var.

## Fixes:

None

## Changes:
Please provide a list of the changes implemented by this PR

* add `supportEmail` in appConfig
* add a card in /help component


## Tests included
- [ ] Included for each change/fix?
- [x] Passing? (Merge will not be approved unless this is checked) 

## Documentation
- [ ] swagger documentation updated \[required\]
- [x] official documentation updated \[nice-to-have\] SciCatProject/documentation#81

### official documentation info
N/A

## Backend version
- [ ] Does it require a specific version of the backend
- which version of the backend is required:

## Summary by Sourcery

Add supportEmail configuration and display contextual help cards in the
UI

New Features:
- Introduce supportEmail environment variable in AppConfig
- Render a “Questions or issues?” card on the /help page when
supportEmail is set
- Render a “Getting help” card on the /about page for PSI facility with
optional contact email
@minottic
Copy link
Member

I think these config options are a bit outdated, but good to have this new option here, thanks!

omkar-ethz added a commit to SciCatProject/frontend that referenced this pull request Jul 10, 2025
…rtEmail (#1933)

This PR adds an environment variable `supportEmail`. If set, a card
"Questions or issues" is added in the `/help` page like so:
![Screenshot from 2025-07-08
14-55-16](https://github.com/user-attachments/assets/789f4e20-ee0f-49b3-badf-2ee4f54666e9)

Currently, users had no way to look up a contact email in case of issues
or questions. This PR adds it via a configurable `supportEmail` env var.

None

Please provide a list of the changes implemented by this PR

* add `supportEmail` in appConfig
* add a card in /help component

- [ ] Included for each change/fix?
- [x] Passing? (Merge will not be approved unless this is checked)

- [ ] swagger documentation updated \[required\]
- [x] official documentation updated \[nice-to-have\] SciCatProject/documentation#81

N/A

- [ ] Does it require a specific version of the backend
- which version of the backend is required:

Add supportEmail configuration and display contextual help cards in the
UI

New Features:
- Introduce supportEmail environment variable in AppConfig
- Render a “Questions or issues?” card on the /help page when
supportEmail is set
- Render a “Getting help” card on the /about page for PSI facility with
optional contact email
@Junjiequan Junjiequan merged commit 1cfb5d7 into SciCatProject:master Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants