Skip to content

SLEAK-5896 + SLEAK-5875: docs release 2.12.1 fixes#216

Open
agustinoli wants to merge 10 commits into
developfrom
docs/release-2.12.1-fixes
Open

SLEAK-5896 + SLEAK-5875: docs release 2.12.1 fixes#216
agustinoli wants to merge 10 commits into
developfrom
docs/release-2.12.1-fixes

Conversation

@agustinoli

Copy link
Copy Markdown
Contributor

Summary

Consolidates three doc fixes for release 2.12.1 (replaces #213, #214, #215):

  • SLEAK-5896: environment-exhaustive-testing-guide (EN+ES) no longer names Grafana specifically in the cost-vs-risk intro or the default metrics list in the Observability section — keeps the guidance tool-agnostic per Mati's review.
  • SLEAK-5875: corrected the dependency-access docs — RDS at-rest encryption is now on by default for new dependencies (opt-out available, Aurora always encrypted), not off by default as previously documented. Ported the missing "Dependency Access" section to EN for parity.
  • Unrelated pre-existing fix: corrected a broken ES anchor link in postgresql-dump-restore that pointed to an English slug on a Spanish heading.

Test plan

  • make build — clean, no broken links/anchors
  • Review EN + ES wording in preview

agustinoli added 10 commits July 1, 2026 14:29
Per Mati's review, the cost-vs-risk intro no longer says "configure
alerts in Grafana" — that reads as a how-to we don't cover. It now
points to reviewing latency/error-rate metrics that aren't included
by default. Also fixed the Section 6 anchor link, which was already
broken (missing "y alertas"/"and Alerts" suffix).
The bot was answering that databases are encrypted with KMS at rest.
storage_encrypted defaults to False in the RDS Pulumi module
(core/apps/crm/modules/dependency/aws/rds.py) — it's only on if a KMS
key is configured at creation time. Added that as a bullet next to the
existing SSL/TLS note in ES, and ported the whole "Dependency Access"
section to EN, which didn't have it at all.
Section 6 already says Grafana dashboards include latency and error
rate by default, so the previous phrasing ("metrics we don't include
by default") contradicted it. What's not on by default is alerting on
those metrics — reworded to say that instead.
…AK-5875)

The previous wording described the pre-06/2026 behavior. Since
ae8c16d1 (RDS improvements), storageEncrypted defaults to true in the
creation schema for MySQL/PostgreSQL/MariaDB/Oracle, and Aurora has
always hardcoded storage_encrypted=True with no opt-out. Only
dependencies created before that change may lack the flag — called
that out instead of stating a blanket "not encrypted by default".
Cost-vs-risk intro now says "any monitoring stack" instead of naming
Grafana specifically. Trimmed the default metrics list in the
Observability section to what dashboards reliably show out of the box.
The link pointed to the English anchor slug
(#how-do-i-create-a-postgresql-database-dump) on a page whose heading
is in Spanish. Updated it to the actual generated slug.
@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@agustinoli, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 31 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b0fbb978-168f-431d-8054-548996d9e85e

📥 Commits

Reviewing files that changed from the base of the PR and between b377086 and 5c3bd01.

📒 Files selected for processing (5)
  • content/docs/en/project/dependency/index.mdx
  • content/docs/es/project/dependency/index.mdx
  • content/tutorials/en/environment-exhaustive-testing-guide.mdx
  • content/tutorials/es/environment-exhaustive-testing-guide.mdx
  • content/tutorials/es/postgresql-dump-restore.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/release-2.12.1-fixes

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

Comment @coderabbitai help to get the list of available commands.

@agustinoli agustinoli left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review realizada sobre el diff consolidado (SLEAK-5896 + SLEAK-5875 + fix de anchor). Verificado contra código real, no solo el diff:

  • storageEncrypted con default: true en los fixtures de RDS (core/apps/dependency/fixtures/postgres.json y análogos) tras el commit ae8c16d1, y storage_encrypted=True hardcodeado en core/apps/crm/modules/dependency/aws/aurora.py:193 — respalda el texto sobre encriptación at-rest en content/docs/{en,es}/project/dependency/index.mdx.
  • El heading real "Section 6: Observability and Alerts" (EN) / "Sección 6: Observabilidad y alertas" (ES) en environment-exhaustive-testing-guide.mdx respalda los anchors corregidos.
  • El heading real en postgresql-aws.mdx:44 respalda el anchor corregido en postgresql-dump-restore.mdx.
  • La sección "Dependency Access" portada a EN es fiel a la versión ES (index.mdx:112-177), sin contenido inventado.

SPEC/PLAN cross-check: no aplica, sin feature directory correspondiente en engineering-specs.

Sin hallazgos — 0 🔴 / 0 🟠 / 0 🟡.

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