Add in user documentation for configs #186
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
User documentation for configs
Summary
Created a readme file for the new configs. PR to merge into the 733 branch as the 733 branch is the branch that actually implements the new config, so will need to familiarise yourself with the new config as part of the review. It's a fairly simple change from a user-facing perspective, just splitting the config into a user config and a dev config. The user config has the bucket name, filepaths and period information, and the dev config has everything else.
Type of Change
Checklists
This pull request meets the following requirements:
Creator Checklist
If you feel some of these conditions do not apply for this pull request, please
add a comment to explain why.
Reviewer Checklist
Additional Information
Please provide any additional information or context that would help the reviewer understand the changes in this pull request.
Related Issues
Link any related issues or pull requests here.