Fix logging and update README for Chaos testing#3
Merged
Merged
Conversation
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
1 participant
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.
This pull request makes significant improvements to the documentation and legal clarity of the project, as well as minor codebase enhancements. The most important changes are:
Documentation and Project Overview Improvements:
The
README.mdhas been extensively rewritten to provide a clearer, more detailed, and up-to-date walkthrough of the demo, including improved architecture diagrams, step-by-step deployment and demo instructions, and explanations of each component and its purpose. The documentation now better explains the closed-loop SRE workflow, prerequisites, and how to run and reset the demo. [1] [2] [3] [4]New sections have been added to the
README.mdfor Terraform variable documentation, clean-up instructions, and a disclaimer about the project's intended use and licensing.Legal and Licensing:
LICENSE.mdfile has been added, explicitly licensing the project under the MIT License.Codebase Enhancements:
apps/api/app/__init__.pyfile now imports additional modules (logging,os, and FastAPI exception handlers) in preparation for improved error handling and logging.These changes make the project easier to understand, use, and maintain, and clarify its legal status.