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

Move help website URL to .env or admin setting #974

Closed
spearec opened this issue Jul 29, 2023 · 2 comments · Fixed by #1096
Closed

Move help website URL to .env or admin setting #974

spearec opened this issue Jul 29, 2023 · 2 comments · Fixed by #1096
Assignees

Comments

@spearec
Copy link
Contributor

spearec commented Jul 29, 2023

Is your feature request related to a problem? Please describe.

Currently, the OED help base URL, which is used in TooltipHelpComponent to determine where to route users when they click help buttons.

// Normal/live URL for OED help pages
// Exported to HeaderButtonsComponent and LanguageSelectorComponent
export const BASE_URL = 'https://openenergydashboard.github.io/help/'
// Debug URL where need to put own GitHub ID before .github.io.
// This works if you have a fork of the web pages and setup your GitHub account to serve them up.
// export const BASE_URL = `https://xxx.github.io/OpenEnergyDashboard.github.io/help/`;

Describe the solution you'd like

Instead of being stored in the code, this base URL should be stored in .env or should be an admin setting.
This would allow sites who want to host their own fork of OED help, such as in cases of poor long-distance internet connection, to easily change the URL without editing OED's code.

Describe alternatives you've considered

Leave the URL in the code, until an OED user requests otherwise.

@huss
Copy link
Member

huss commented Jul 31, 2023

To allow non-admins to control OED as much as possible, I would prefer to see this be a part of the admin user pages. The default value would be the standard location of OED help on the web (current value set by code).

Note that issue #890 will update the admin user pages for React hooks and a new look. It might be best to do this work after that is complete since it is low priority.

@Jake-Bodin
Copy link
Contributor

I would like to work on this issue

@huss huss closed this as completed in #1096 Dec 3, 2023
huss added a commit that referenced this issue Dec 3, 2023
Issue #974 Moves help website url to admin user pages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants