Skip to content

docs: organize CloudMonitor documentation under docs/ - #15

Merged
ayushcmd merged 3 commits into
mainfrom
docs/cloudmonitor-documentation-refresh
Oct 27, 2026
Merged

ayushcmd merged 3 commits into
mainfrom
docs/cloudmonitor-documentation-refresh

Conversation

@ayushcmd

@ayushcmd ayushcmd commented Oct 27, 2026 •

Copy link
Copy Markdown
Owner

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

  • Distinguishes local Compose from the production Compose stack.
  • Records the current demo URL as HTTP, and warns against sending real credentials or agent keys over it.
  • Notes that Grafana and cAdvisor are in local Compose but not in the current production Compose stack; cAdvisor is not a current Prometheus scrape target.
  • Notes that Alertmanager webhook receiver lists are empty, so external notification delivery is not claimed as working.
  • Preserves PostgreSQL volume safety requirements and records Systems Manager migration as future work.
  • Lists Sarnendu Das, Parveen Kumar and Ayush Raj equally without assigning unconfirmed individual roles.
  • Fixes the stale clone URL that pointed to a different repository and updates links for the new docs/ locations.

Validation

  • Fetched the three documentation files from the branch after writing them.
  • Moved the two detailed guides and full project README into docs/, then verified their contents are present there.
  • Removed the duplicate full-length guide files from the repository root.
  • No application code, Compose files, workflows, AWS resources or production data were modified.

Review caution

This PR is not merged. Merging into main may trigger the existing production CD workflow; recent SSH connectivity failures remain unresolved, so review the workflow behavior before merging.

@ayushcmd ayushcmd self-assigned this Oct 27, 2026
@ayushcmd ayushcmd changed the title docs: rewrite CloudMonitor project README docs: refresh CloudMonitor README and detailed project guides Oct 27, 2026
@ayushcmd
ayushcmd merged commit 53fd641 into main Oct 27, 2026
3 checks passed
@ayushcmd ayushcmd changed the title docs: refresh CloudMonitor README and detailed project guides docs: organize CloudMonitor documentation under docs/ Oct 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant