Config Documentation #255
Config Documentation #255
Conversation
Co-Authored-By: jcrichlake <[email protected]>
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
PR Code Suggestions ✨No code suggestions found for the PR. |
adr/012-configs.md
Outdated
|
|
||
| ## Notes | ||
| - config files should only contain non-secret values | ||
| - 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) |
There was a problem hiding this comment.
Is the naming convention documented somewhere?
There was a problem hiding this comment.
SECRETS.md contains the current naming convention for secrets.
There was a problem hiding this comment.
It might be helpful to link out to it
There was a problem hiding this comment.
This has been added to where the notes were moved which is in configs.md
Co-Authored-By: jcrichlake <[email protected]>
| # FAQ | ||
| - We use the partner's organization name in ReportStream as the partner ID | ||
| - Config files are the partner ID plus `.json` | ||
| - Config keys in code are the partner ID |
There was a problem hiding this comment.
Could an example of what that would look like be added?
| @@ -0,0 +1,11 @@ | |||
| # FAQ | |||
There was a problem hiding this comment.
Loving the FAQ section. Great idea!
adr/012-configs.md
Outdated
|
|
||
| ## Decision | ||
|
|
||
| We will store partner config settings in an Azure container |
There was a problem hiding this comment.
nit: consider being more specific here, .i.e. "We will store partner sftp config settings..."
|
Adding Docs
This PR adds ADRs around our usage of configs and a readme for FAQs that pertain to config questions.
Issue
SFTP config