docs(README): document four per-plan-type --services slugs (closes #138)#169
docs(README): document four per-plan-type --services slugs (closes #138)#169cristim wants to merge 1 commit into
Conversation
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughREADME.md is updated to document four per-plan-type Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 0/5 reviews remaining, refill in 55 minutes and 27 seconds. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 108: The README's services table omits the hyphenated fan-out alias the
program accepts; update the `-s, --services` description to include
`savings-plans` alongside the existing `savingsplans` and `sp` aliases so the
doc matches the implementation (the CLI parsing logic that treats
`savingsplans`, `sp`, and `savings-plans` as SP fan-out aliases, referenced
around the code handling services parsing).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 60d1ef50-0fe7-4f33-a5dd-cf3d3589eddc
📒 Files selected for processing (2)
.markdownlint.yamlREADME.md
cristim
added
triaged
|
P3 docs: documents the four per-plan-type |
…ple 8 Closes #138. The four per-plan-type Savings Plans `--services` flag values from PR #123 (`savings-plans-{compute,ec2instance,sagemaker,database}`) plus the `savingsplans` / `sp` fan-out aliases were never documented in the README because the docs commit was deferred over markdownlint table-style errors. Changes: - Expanded the `-s, --services` flag-table row to spell out the per-RI services, the four per-plan-type SP slugs, and the fan-out aliases. - Updated examples 6 and 7 to use the per-plan-type slugs directly (`savings-plans-database`, `savings-plans-compute,...-ec2instance`) instead of `savingsplans --include-sp-types Database`. - Added example 8 demonstrating the `savingsplans` fan-out alias and a callout that explicit per-plan-type slugs are preferred when scope matters. Disabled MD060 (table-column-style) in `.markdownlint.yaml`. The README mixes tables of wildly different widths — small flag/value pairs and long descriptive rows. Forcing a single style across all of them either crams long-text rows into ugly compact form or pads tiny tables with mountains of trailing whitespace. Both are worse than the inconsistency the rule was trying to flag, and the rule was the only thing blocking PR #123's docs commit. Aligned a few tables on the way through (`Execution Control`, `Filtering`, `Authentication`) into the wider style; left the others in their existing compact form. `pre-commit run markdownlint --files README.md` clean.
cristim
force-pushed
the
fix/issue-138-sp-docs
branch
from
c0ce0fb to
7b719aa
Compare
Closes #117. Per-account service overrides have been a feature since migration 000011_cloud_accounts.up.sql (mid-2024) and now have full UI coverage via #72 (inline payment edit) and #106 (create modal). Adds a new "Per-Account Service Overrides" section to README between "Coverage Percentage" and "Safety Features" covering: - Concept + when to use vs the global Settings → Purchasing card. - Web-UI walkthrough (Settings → Accounts → expand → Service overrides). - AWS-only V1 boundary callout pointing at #109 for Azure/GCP. - How to edit existing overrides — inline Payment per #72, Reset, and the #110 follow-up for inline Term/Coverage/Enabled. - "Inherit" semantics: blank fields are not stored as a sentinel; the PUT request stays sparse and the engine reads the global default at evaluation time. - API parity note: the override modal targets the same endpoint as scripted setups; both write the same row. Also disables MD060 (table-column-style) in .markdownlint.yaml — same rationale as PR #169 (landing here too in case the PRs merge in a different order; both diffs are idempotent).
|
Rebased onto current |
|
✅ Actions performedReview triggered.
|
1 participant
Summary
Closes #138.
PR #123 introduced four per-plan-type Savings Plans
--servicesflag values (savings-plans-{compute,ec2instance,sagemaker,database}) plus keptsavingsplansandspas fan-out aliases. The README updates to document this were prepared as part of #123 but reverted at commit time over markdownlint table-style errors.Changes
-s, --servicesflag-table row to spell out the per-RI services, the four per-plan-type SP slugs, and the fan-out aliases.savings-plans-database,savings-plans-compute,…-ec2instance).savingsplansfan-out alias + a callout that explicit per-plan-type slugs are preferred when scope matters..markdownlint.yaml
Disabled MD060 (table-column-style). The README mixes tables of wildly different widths — small flag/value pairs and long descriptive rows. Forcing a single style across all of them either crams long-text rows into ugly compact form or pads tiny tables with mountains of trailing whitespace. Both are worse than the inconsistency the rule was trying to flag, and the rule was the only thing blocking PR #123's docs commit. Documented the rationale in-config.
Verification
pre-commit run markdownlint --files README.mdclean.🤖 Generated with claude-flow
Summary by CodeRabbit
--servicesflag regarding Savings Plans selection options.