Repository navigation
docs: organize CloudMonitor documentation under docs/ - #15
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
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.
Summary
Organizes the CloudMonitor documentation into a dedicated
docs/folder and keeps the repository root clean.Structure
README.md(root): short GitHub landing page linking to the documentation folder.docs/README.md: full project overview, live demo warning, problem statement, technology stack, architecture diagram, local installation, endpoint summary and team.docs/PROJECT_BUILD_AND_ARCHITECTURE.md: in-depth design, frontend/backend, API routes, agent telemetry flow, PostgreSQL, Prometheus, Node Exporter, Grafana, cAdvisor, Alertmanager, local setup and limitations.docs/AWS_DEPLOYMENT_AND_OPERATIONS.md: EC2/Compose deployment, networking, environment configuration, monitoring, CI/CD status, planned Systems Manager migration, PostgreSQL backup/restore, rollback, cost considerations and troubleshooting.Accuracy and safety notes
Validation
docs/, then verified their contents are present there.Review caution
This PR is not merged. Merging into
mainmay trigger the existing production CD workflow; recent SSH connectivity failures remain unresolved, so review the workflow behavior before merging.