Move environment variable documentation into .env.sample (!10) · Merge requests · NDIP / Nova Dashboard · GitLab

During the maintenance period on Monday, 14 Oct 2024, all new projects will no longer create a container registry as part of the project area. Already existing projects will be unaffected at this time. Instead, users should utilize the official ORNL container registries at camden.ornl.gov (internal/moderate) and savannah.ornl.gov (external/low). Please see ORNL Today article for more info.

Admins will be upgrading ORNL GitLab Servers on Monday, 11 Nov 2024, from 5 PM until 7 PM EST. Repositories will experience intermittent outages during this time.

Duggan, John requested to merge 13-move-environment-variable-documentation-into-env-sample into dev Oct 21, 2024

Summary of Changes

Removes the incomplete documentation on environment variables from the readme and puts more complete documentation into .env.sample.

Checklist

The MR has a clear and concise title
Code is self-documented and follows style guidelines.
Automated tests are written and pass successfully.
Regression tests (e.g. manually triggered system tests, manual GUI/tool tests, ...) are performed to make sure the MR does not break anything (when applicable)
Readme file is present and up-to-date.

Documentation Updates

Additional Notes

Closes #13 (closed)