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

UI customisations: Customisable product name & footer text #6

Open
jonnyry opened this issue Nov 24, 2023 · 5 comments
Open

UI customisations: Customisable product name & footer text #6

jonnyry opened this issue Nov 24, 2023 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@jonnyry
Copy link

jonnyry commented Nov 24, 2023

Allow the following to be customisable via the use of environment/deployment variables:

  • Product Name
  • Footer text

Nb. these have already been customised in issue #2, however this ticket extends the ability to customise them via variables.

asasaas

@jonnyry jonnyry self-assigned this Nov 24, 2023
@vvcb
Copy link

vvcb commented Nov 25, 2023

It will also be great to have a deployment time and commit hash and/or version tag in the footer.

And conditional CSS so that the Dev, test and prod deployments are visually different.

@jonnyry jonnyry changed the title Add environment name (DEV, TEST, STAGE) to UI top nav bar UI customisations: Show environment name, deployment time & Git hash/tag Nov 27, 2023
@jonnyry
Copy link
Author

jonnyry commented Nov 27, 2023

Proposed solution:

Variables

Var name Description Example Mandatory Default if not set Where set/generated Fixed in issue
UI_PRODUCT_NAME TRE product name shown in UI Azure TRE no (not shown) config.yaml for local make deployments, GitHub Actions variable for GitHub Actions deploy (this issue)
UI_FOOTER_TEXT Footer text in bottom status panel of UI Azure Trusted Research Environment no (not shown) config.yaml for local make deployments, GitHub Actions variable for GitHub Actions deploy (this issue)
UI_ENV_NAME Text to shown on environment label in UI DEV, STAGE, TEST no Azure TRE config.yaml for local make deployments, GitHub Actions variable for GitHub Actions deploy (this issue)
UI_ENV_LABEL_COLOUR Background colour of label #555555 no Azure Trusted Research Environment config.yaml for local make deployments, GitHub Actions variable for GitHub Actions deploy (this issue)
DEPLOY_TIME (Last) deployment time 2023-11-27 T13:24:30 no (not shown) Generated in GitHub Action / Makefile on deploy #5
GITHUB_REF GitHub REF - i.e. branch name OR tag develop, v0.15.2 no (not shown) Generated in GitHub Action / Makefile on deploy #5
GITHUB_HASH Commit hash 1e4683f no (not shown) Generated in GitHub Action / Makefile on deploy #5

Placement in the UI

Capture

@jonnyry
Copy link
Author

jonnyry commented Nov 27, 2023

@vvcb could you review the above before I implement the changes?

@vvcb
Copy link

vvcb commented Nov 27, 2023

@jonnyry , this looks comprehensive. 🚀 Happy for this to be implemented.

@vvcb vvcb added the enhancement New feature or request label Nov 27, 2023
@jonnyry jonnyry changed the title UI customisations: Show environment name, deployment time & Git hash/tag UI customisations: Environment name, product name & footer text Nov 28, 2023
@jonnyry
Copy link
Author

jonnyry commented Nov 28, 2023

Splitting into three issues due to complexities around Git ref/hash & potential for merging back upstream:

@jonnyry jonnyry changed the title UI customisations: Environment name, product name & footer text UI customisations: Customisable product name & footer text Nov 28, 2023
@jonnyry jonnyry transferred this issue from another repository Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants