Enhance docs: Terraform, API Gateway, bootstrap#90
Merged
Kayle-Verhiel merged 2 commits intomainfrom Mar 22, 2026
Merged
Conversation
Revamp and expand documentation across the repo: - lifewatch_batch_platform/terraform/environments/dev/readme.md: Add new GET /batch/jobs/history_list route and lambda_job_history_list; update lambda ZIP default paths to ../../backend_lambda_artifacts/*; update service diagrams and module list to include history_list. - lifewatch_batch_platform/terraform/modules/api_gateway/readme.md: Update resource/method/integration inventory to explicitly list multipart support, routes (including history_list), methods, and integration/response behavior. - readme.md (root): Full rewrite to "LifeWatch Notebook Platform DevOps" with clearer repository layout, prerequisites, workflows, onboarding checklist, Terraform dev instructions, CI/CD secrets matrix, troubleshooting, and scope notes (removes old local/Django/minikube-centric content). - terraform-bootstrap/readme.md: Condense and clarify bootstrap purpose, list files, provide backend example with standardized bucket/key/table names, and add operational notes. These changes improve clarity for developers running and maintaining the Terraform dev environment, align naming conventions, and document the new history_list Lambda endpoint.
Closed
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
2 participants
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.
Issue
ISSUE > Update the Docs
Description
This pull request primarily updates documentation to improve clarity, onboarding, and infrastructure transparency for the LifeWatch Notebook Platform DevOps project. The changes expand and modernize the main project
readme.md, overhaul the Terraform bootstrap guide, and update the dev environment and API Gateway module documentation to reflect new routes, Lambda handlers, and resource structure.Major documentation improvements and infrastructure updates:
1. Project Documentation Overhaul
readme.mdto provide a comprehensive overview of the repository, including components, workflows, onboarding, validation commands, security practices, troubleshooting, and secrets management. Removes outdated local Django/Kubernetes instructions in favor of AWS/Terraform-centric workflows.2. Terraform Bootstrap Documentation
terraform-bootstrap/readme.mdwith a concise guide explaining the purpose, usage, and operational notes for the remote state S3 bucket and DynamoDB lock table, including a backend configuration example for environment stacks.3. API Gateway and Lambda Integration Updates
GET /batch/jobs/history_listAPI route and its associated Lambda handler (lambda_job_history_list) across the dev environment'sreadme.md, including updates to the API Gateway resource diagram, Lambda artifact paths, and module table. [1] [2] [3] [4] [5]backend_lambda_artifactsdirectory for better organization and clarity.4. API Gateway Module Documentation
modules/api_gateway/readme.mdto accurately describe the resources created, including explicit listing of all API Gateway resources, supported routes, and integration types, replacing the previous generic resource descriptions.These changes collectively improve the onboarding experience, clarify infrastructure design, and ensure documentation accurately reflects the current state of the codebase and deployment workflows.
Type of change
How has this been tested?
Describe how you verified that your changes work correctly. Include any relevant commands, test cases, or environments used. If no testing was needed, explain why.
Notes for reviewers
Anything you want to flag for reviewers such as areas of uncertainty, known limitations, deliberate tradeoffs, or specific things you would like feedback on. Leave blank if nothing needs highlighting.
Checklist
Go through each item before marking the PR as ready for review.