Docs for environment variables, parameterize some constants #38

Merged
0950726 merged 5 commits from feat/environment-variables into dev 2026-01-06 09:02:49 +00:00
0950726 commented 2025-12-11 12:43:36 +00:00 (Migrated from git.science.uu.nl)

This merge request adds documentation explaining how to use environment variables, including which variables are available. Importantly, it removes some hard coded constants ("localhost") and makes these configurable.

To verify:

  • Style checks pass
  • Pipeline (tests) pass
  • Documentation is up to date
  • Tests are up to date (new code is covered)
  • Follow the instructions in the README to create and use environment variables, are the docs clear?
    • Test by setting the APP_TITLE environment variable
    • The first log message should be "<APP_TITLE> is starting up."

ref: N25B-352

This merge request adds documentation explaining how to use environment variables, including which variables are available. Importantly, it removes some hard coded constants ("localhost") and makes these configurable. To verify: - [x] Style checks pass - [x] Pipeline (tests) pass - [x] Documentation is up to date - [x] Tests are up to date (new code is covered) - [x] Follow the instructions in the README to create and use environment variables, are the docs clear? - [x] Test by setting the `APP_TITLE` environment variable - [x] The first log message should be "<APP_TITLE> is starting up." ref: N25B-352
2584433 commented 2025-12-14 21:58:10 +00:00 (Migrated from git.science.uu.nl)

assigned to @0950726

assigned to @0950726
2584433 commented 2025-12-14 21:58:12 +00:00 (Migrated from git.science.uu.nl)

requested review from @2584433

requested review from @2584433
2584433 commented 2025-12-14 22:00:28 +00:00 (Migrated from git.science.uu.nl)

marked the checklist item Style checks pass as completed

marked the checklist item **Style checks pass** as completed
2584433 commented 2025-12-14 22:00:29 +00:00 (Migrated from git.science.uu.nl)

marked the checklist item Pipeline (tests) pass as completed

marked the checklist item **Pipeline (tests) pass** as completed
2584433 commented 2025-12-14 22:07:12 +00:00 (Migrated from git.science.uu.nl)

marked the checklist item Documentation is up to date as completed

marked the checklist item **Documentation is up to date** as completed
2584433 commented 2025-12-14 22:07:13 +00:00 (Migrated from git.science.uu.nl)

marked the checklist item Tests are up to date (new code is covered) as completed

marked the checklist item **Tests are up to date (new code is covered)** as completed
2584433 commented 2025-12-14 22:14:01 +00:00 (Migrated from git.science.uu.nl)

marked the checklist item Follow the instructions in the README to create and use environment variables, are the docs clear? as completed

marked the checklist item **Follow the instructions in the README to create and use environment variables, are the docs clear?** as completed
2584433 commented 2025-12-14 22:14:02 +00:00 (Migrated from git.science.uu.nl)

marked the checklist item Test by setting the APP_TITLE environment variable as completed

marked the checklist item **Test by setting the `APP_TITLE` environment variable** as completed
2584433 commented 2025-12-14 22:14:03 +00:00 (Migrated from git.science.uu.nl)

marked the checklist item The first log message should be "<APP_TITLE> is starting up." as completed

marked the checklist item **The first log message should be "<APP_TITLE> is starting up."** as completed
2584433 commented 2025-12-14 22:16:10 +00:00 (Migrated from git.science.uu.nl)

I'd say "see the control_bakcend.core.config.py module in src/control backend."
I may be stupid, but i thought you meant the autogenerated docs.

Anyway rest is fine 👍

I'd say "see the `control_bakcend.core.config.py` module in src/control backend." I may be stupid, but i thought you meant the autogenerated docs. Anyway rest is fine :thumbsup:
2584433 commented 2025-12-14 22:16:18 +00:00 (Migrated from git.science.uu.nl)

approved this merge request

approved this merge request
0950726 commented 2025-12-16 08:38:39 +00:00 (Migrated from git.science.uu.nl)

I did mean the autogenerated docs 😅 I think that'll be the easiest place to find them, rather than having to go through code.

I did mean the autogenerated docs 😅 I think that'll be the easiest place to find them, rather than having to go through code.
0950726 commented 2025-12-16 08:39:18 +00:00 (Migrated from git.science.uu.nl)

marked this merge request as draft

marked this merge request as **draft**
0950726 commented 2025-12-16 08:39:58 +00:00 (Migrated from git.science.uu.nl)

I want to wait for !36 to be merged, have to make a change when it is.

I want to wait for !36 to be merged, have to make a change when it is.
0950726 commented 2025-12-29 11:33:37 +00:00 (Migrated from git.science.uu.nl)

marked this merge request as ready

marked this merge request as **ready**
0950726 commented 2025-12-29 11:41:24 +00:00 (Migrated from git.science.uu.nl)

added 23 commits

  • 0c682d64...adbb7ffd - 21 commits from branch dev
  • 5282c247 - Merge remote-tracking branch 'origin/dev' into feat/environment-variables
  • 7d798f2e - Merge remote-tracking branch 'origin/dev' into feat/environment-variables

Compare with previous version

added 23 commits <ul><li>0c682d64...adbb7ffd - 21 commits from branch <code>dev</code></li><li>5282c247 - Merge remote-tracking branch &#39;origin/dev&#39; into feat/environment-variables</li><li>7d798f2e - Merge remote-tracking branch &#39;origin/dev&#39; into feat/environment-variables</li></ul> [Compare with previous version](/ics/sp/2025/n25b/pepperplus-cb/-/merge_requests/38/diffs?diff_id=136189&start_sha=0c682d6440485007ed0aed885627d8d16a4750f9)
2584433 commented 2025-12-29 13:59:19 +00:00 (Migrated from git.science.uu.nl)

resolved all threads

resolved all threads
9828273 commented 2026-01-06 08:41:06 +00:00 (Migrated from git.science.uu.nl)

resolved all threads

resolved all threads
9828273 commented 2026-01-06 08:41:07 +00:00 (Migrated from git.science.uu.nl)

approved this merge request

approved this merge request
9828273 commented 2026-01-06 08:41:50 +00:00 (Migrated from git.science.uu.nl)

unapproved this merge request

unapproved this merge request
9828273 commented 2026-01-06 09:02:36 +00:00 (Migrated from git.science.uu.nl)

resolved all threads

resolved all threads
9828273 commented 2026-01-06 09:02:41 +00:00 (Migrated from git.science.uu.nl)

approved this merge request

approved this merge request
9828273 commented 2026-01-06 09:02:50 +00:00 (Migrated from git.science.uu.nl)

mentioned in commit 612a96940d

mentioned in commit 612a96940d82535ec0ff0d809c5597200bc0b063
9828273 (Migrated from git.science.uu.nl) merged commit 612a96940d into dev 2026-01-06 09:02:50 +00:00
2584433 (Migrated from git.science.uu.nl) approved these changes 2026-02-02 13:29:05 +00:00
9828273 (Migrated from git.science.uu.nl) approved these changes 2026-02-02 13:29:05 +00:00
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: pepperplus/pepperplus-cb#38