Migrate README generation to atmos

[goruha]

what

• Update README.yaml

why

• Use atmos to generate readme

Summary by CodeRabbit

• Documentation

  • Overhauled and reorganized docs with clearer usage guidance, CloudTrail integration details, object lock defaults, and multi-environment tips.
  • Added contributor guidelines covering project structure, tooling, testing, conventions, and security practices.
  • Expanded references, badges, support links, and testing instructions; refreshed metadata and formatting.

• Chores

  • Updated ignore rules to exclude common cache/directories across the repo.
  • Introduced centralized configuration for Atmos-based workflows.
  • Removed legacy build script in favor of streamlined tooling.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds Atmos scaffolding via a new atmos.yaml import, updates .gitignore, removes Makefile harness, and extensively restructures documentation (README.md, README.yaml, src/README.md) with a new AGENTS.md contributor guide. No functional code changes; primarily configuration and docs.

Changes

Cohort / File(s)	Summary of Changes
Repository scaffolding & config atmos.yaml, .gitignore, Makefile	Added Atmos config importing a shared Terraform component YAML; ignored .cache and .atmos everywhere; removed previous Build Harness-based Makefile and its targets.
Project documentation overhaul README.md, README.yaml, src/README.md	Rewrote and reorganized docs, clarified Datadog log archive behavior, CloudTrail integration, object lock defaults, Atmos/Terratest usage, and metadata (badges, tags, references, license, categories).
Contributor guidelines AGENTS.md	Added detailed repo standards for structure, tooling (Atmos, Terratest, terraform-docs, TFLint), workflows, testing, and PR conventions.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant ATM as Atmos CLI
  participant CFG as Remote Config (import)
  participant TF as Terraform
  participant TT as Terratest (Go)

  Dev->>ATM: atmos docs/test/apply
  ATM->>CFG: import terraform-component.yaml
  CFG-->>ATM: shared component config
  ATM->>TF: generate/run component with merged config
  alt Tests
    TF-->>TT: provisioned infra details
    TT->>TF: assertions & cleanup
  else Docs
    ATM-->>Dev: README generation via terraform-docs
  end
  note over ATM,TF: New: centralized config via import

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I tidied my burrow with Atmos light,
Swept Makefile crumbs into the night.
New scrolls unfurled—README bright,
AGENTS guide my hops just right.
With tags and trails in tidy rows,
I thump approval—onward it goes! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8263673 and 7d61349.

📒 Files selected for processing (7)

• .gitignore (1 hunks)
• AGENTS.md (1 hunks)
• Makefile (0 hunks)
• README.md (5 hunks)
• README.yaml (2 hunks)
• atmos.yaml (1 hunks)
• src/README.md (3 hunks)

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch migration/20251908

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[mergify]

Important

Cloud Posse Engineering Team Review Required

This pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes.

To expedite this process, reach out to us on Slack in the #pr-reviews channel.

[github-actions]

These changes were released in v1.536.1.