Finalise V1.0 of docs - #83
Merged
Merged
Conversation
Contributor
Author
|
Note (I've already included these in the docs but just to be explicit) - I've implemented the following
Additionally, Alex has put more protection in the |
Contributor
Author
|
@AlexRossKnox
I wasn't sure how |
AlexRossKnox
approved these changes
Jul 21, 2026
The previous version described a Lambda based architecture that doesn't match the ECS Fargate stack in the CDK app. This skeleton lays out the sections for a rewrite
Remove stale core stack read me
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
The following existing docs have been substantially updated:
README.md- rewritten as a short entry point that links out to the guides below, instead of holding everything itselfdocs/DEVELOPMENT.md- expanded with dependency management, git workflow, notebooks, testing, and pre-commit sectionsdocs/running-pipelines.md- reworked into a quick-reference table covering local, Docker/ECR, GitHub Actions, and prod runs.github/PULL_REQUEST_TEMPLATE/prod_template.md- added image-freshness and post-merge checklist itemsThe following documentation files have been added:
docs/CONTRIBUTING.md- PR process, branching conventions, and issue labelling (area:*/type:*)docs/adding-pipelines.md- end-to-end guide for building a new pipeline (Hamilton dataflow pattern, bronze/silver/gold stages, registering inpipelines.yaml)docs/templates/pipelines/README.md- template to copy when writing a new pipeline's READMEasf_mission_data/pipeline/example/README.mdasf_mission_data/pipeline/energy_price_cap_levels_annex_9/README.mdasf_mission_data/pipeline/heat_pump_deployment_statistics/README.md.github/pull_request_template.md- single dev-merge PR template, replacing.github/PULL_REQUEST_TEMPLATE/dev_template.mdRemoved:
docs/test.md(leftover test file)docs/dag-images/.gitkeep(unused placeholder directory as we are now saving dag images in S3)Other minor changes:
config.pyfor consistency (no behaviour change)..gitignorealso gained a*.ipynb/.ipynb_checkpoints/entry to gitignore all Jupyter notebooks for developmentFixes #76
Type of change
Checklist
uv run pytestpasses locallyuv run pre-commit run --all-filespasses (ruff, gitleaks, etc.)pipelines.yamland has its ownREADME.mddevinto this branchTesting notes
N/A. No changes made to pipeline code.
Instructions for reviewer
Please read through the docs and check if the content makes sense, anything is missing or needs to be clearer. Feel free to commit edits directly.
@AlexRossKnox In addition to double-checking the content I've written in the other docs related to running pipelines, AWS, workflows etc., please could you update
infrastructure/README.md?