Skip to content

Commit

Permalink
docs: update outdated configuration parameter of help menu
Browse files Browse the repository at this point in the history
  • Loading branch information
csm-thu committed Aug 30, 2024
1 parent be1b71c commit d0293ab
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions doc/projectBranding.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,10 @@ by:

These links can be defined in several ways:

- the most straightforward way is to set the values `COSMOTECH_URL` and `SUPPORT_URL` in the file
- the most straightforward way is to set the values `ORGANIZATION_URL` and `SUPPORT_URL` in the file
_src/config/HelpMenuConfiguration.json_
- for automation purposes, these parameters can be overridden by setting the environment variables
`REACT_APP_COSMOTECH_URL` and `REACT_APP_SUPPORT_URL`
`REACT_APP_ORGANIZATION_URL` and `REACT_APP_SUPPORT_URL`
- finally, values for these links can be **customized for each workspace**, by setting these parameters in the workspace
data:

Expand Down
2 changes: 1 addition & 1 deletion doc/workspaceConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Some items of the "_Help_" menu can be configured from the file
[src/config/HelpMenuConfiguration.json](../src/config/HelpMenuConfiguration.json):

- `APP_VERSION` is the webapp version number, that will be displayed in the "_About_" pop-up
- `COSMOTECH_URL` is the url (expressed as a string) to redirect users to your organization website, displayed in the
- `ORGANIZATION_URL` is the url (expressed as a string) to redirect users to your organization website, displayed in the
"_About_" pop-up
- `SUPPORT_URL` is the url (expressed as a string) of the support page. Links to this page will be shown in the
"_About_" pop-up, and as a redirection button in the "_Help_" menu. If this value is set to `null`, the associated
Expand Down

0 comments on commit d0293ab

Please sign in to comment.