Skip to content
This repository was archived by the owner on Feb 7, 2025. It is now read-only.

Config Documentation #255

Merged
merged 12 commits into from
Dec 23, 2024
Prev Previous commit
Next Next commit
Adding configs readme
jcrichlake committed Dec 18, 2024
commit 4e21b64e898b160e8b4645a7c580b669984a3a2d
7 changes: 0 additions & 7 deletions adr/012-configs.md
Original file line number Diff line number Diff line change
@@ -22,13 +22,6 @@ blast radius when changing settings.
- secrets will use a consistent naming pattern based on the partner ID used in config (so we can dynamically assemble the key names in code)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the naming convention documented somewhere?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SECRETS.md contains the current naming convention for secrets.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be helpful to link out to it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has been added to where the notes were moved which is in configs.md

- config keys are their file names (minus .json) and match org names in ReportStream

README
- skipping PR env? Defaults?
- config structure? and/or what settings are included? Maybe not, it was just easy to make it flat
- config loading timing? YAGNI on automagic refresh - restart app to reload configs. This should go somewhere, maybe in a
- folder structure - partner first with import etc inside of it. This might belong in another ADR
- add config for Flexion to enable testing


## Impact

7 changes: 7 additions & 0 deletions docs/configs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
README
- skipping PR env? Defaults?
- config structure? and/or what settings are included? Maybe not, it was just easy to make it flat
- config loading timing? YAGNI on automagic refresh - restart app to reload configs. This should go somewhere, maybe in a
- folder structure - partner first with import etc inside of it. This might belong in another ADR
- add config for Flexion to enable testing