docs(README): document four per-plan-type --services slugs (closes #138) - #169
Conversation
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughREADME.md documents four per-plan-type Savings Plans service slugs, alias fan-out behavior, revised usage examples, and aligned Markdown tables. ChangesREADME Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
|
P3 docs: documents the four per-plan-type |
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.
|
cmd/main.go:180 accepts three fan-out aliases (`savingsplans`,
`savings-plans`, `sp`) that expand to all four per-plan-type SP
slugs. The README listed only two of them (`savingsplans` and
`sp`), so users following the docs would not discover the
hyphenated alias even though the CLI accepts it.
Updates:
- README.md L108 (`-s, --services` table row): add
`savings-plans` to the fan-out alias list so the table matches
parseServices in cmd/main.go.
- README.md L263 (Example 8 comment): mention `savings-plans`
alongside `savingsplans` and `sp` in the "shorthand" prose.
- README.md L273 ("per-plan-type vs alias" callout): update the
alias enumeration to list all three forms.
Closes the CodeRabbit actionable on PR #169 (Line 108: hyphenated
fan-out alias missing from the documented alias set).
CR pass 2: actionable resolvedPushed Fix: Added Three lines touched in
No code or behaviour changes; CLI already accepts the alias. The previous CR thread had an auto-applied @coderabbitai full review |
|
✅ Actions performedFull review triggered. |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@coderabbitai resolve |
✅ Actions performedComments resolved. Approval is disabled; enable |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
✅ Actions performedReview triggered.
|
|
@coderabbitai review |
Rate Limit Exceeded
|
|
@coderabbitai review |
✅ Action performedReview finished.
|
|
@coderabbitai full review |
✅ Action performedFull review finished. |
|
@coderabbitai full review |
✅ Action performedFull review finished. |
cmd/main.go:180 accepts three fan-out aliases (`savingsplans`,
`savings-plans`, `sp`) that expand to all four per-plan-type SP
slugs. The README listed only two of them (`savingsplans` and
`sp`), so users following the docs would not discover the
hyphenated alias even though the CLI accepts it.
Updates:
- README.md L108 (`-s, --services` table row): add
`savings-plans` to the fan-out alias list so the table matches
parseServices in cmd/main.go.
- README.md L263 (Example 8 comment): mention `savings-plans`
alongside `savingsplans` and `sp` in the "shorthand" prose.
- README.md L273 ("per-plan-type vs alias" callout): update the
alias enumeration to list all three forms.
Closes the CodeRabbit actionable on PR #169 (Line 108: hyphenated
fan-out alias missing from the documented alias set).
14f1eef to
5d8bb7d
Compare
|
@coderabbitai review |
✅ Action performedReview finished.
|
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).
|
@coderabbitai review |
✅ Action performedReview finished.
|
cmd/main.go:180 accepts three fan-out aliases (`savingsplans`,
`savings-plans`, `sp`) that expand to all four per-plan-type SP
slugs. The README listed only two of them (`savingsplans` and
`sp`), so users following the docs would not discover the
hyphenated alias even though the CLI accepts it.
Updates:
- README.md L108 (`-s, --services` table row): add
`savings-plans` to the fan-out alias list so the table matches
parseServices in cmd/main.go.
- README.md L263 (Example 8 comment): mention `savings-plans`
alongside `savingsplans` and `sp` in the "shorthand" prose.
- README.md L273 ("per-plan-type vs alias" callout): update the
alias enumeration to list all three forms.
Closes the CodeRabbit actionable on PR #169 (Line 108: hyphenated
fan-out alias missing from the documented alias set).
5d8bb7d to
31f0c62
Compare
|
@coderabbitai review |
✅ Action performedReview finished.
|
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).
…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.
cmd/main.go:180 accepts three fan-out aliases (`savingsplans`,
`savings-plans`, `sp`) that expand to all four per-plan-type SP
slugs. The README listed only two of them (`savingsplans` and
`sp`), so users following the docs would not discover the
hyphenated alias even though the CLI accepts it.
Updates:
- README.md L108 (`-s, --services` table row): add
`savings-plans` to the fan-out alias list so the table matches
parseServices in cmd/main.go.
- README.md L263 (Example 8 comment): mention `savings-plans`
alongside `savingsplans` and `sp` in the "shorthand" prose.
- README.md L273 ("per-plan-type vs alias" callout): update the
alias enumeration to list all three forms.
Closes the CodeRabbit actionable on PR #169 (Line 108: hyphenated
fan-out alias missing from the documented alias set).
Replace U+2014 em-dash with double hyphen in the bash code-block comment added in the per-plan-type slug documentation, keeping prose style consistent with the rest of the file.
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).
31f0c62 to
722cd1f
Compare
) * docs(README): document per-account service overrides 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). * docs(readme): correct stale override edit/delete wording to shipped UI (refs #117) - Replace stale "#110 tracked / delete-and-recreate" limitation with the shipped reality: AWS overrides support inline edit of Term, Payment, Coverage, and Enabled directly on the row; non-AWS providers are read-only. - Rename "Reset" to "Delete" throughout the override-editing section to match the current button label and confirm dialog title (per #114). * docs(README): fix stale provider-boundary and em-dash issues in override section - Replace the stale "AWS-only V1 boundary" callout with accurate text: the override modal is provider-aware and lists services for the account's provider (AWS, Azure, GCP). Issues #109 and #110 shipped and both the create modal and inline-edit work for all providers. - Replace "Non-AWS overrides display field values as read-only text" with the correct statement that all override rows support inline edit (Term, Payment, Coverage, Enabled). References to tracking issue #109 removed as it is closed. - Replace five U+2014 em-dashes in the new section with punctuation that matches the project prose style (semicolons, parentheses, period).
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
--servicesnow documents four explicit per-plan-type slugs (savings-plans-compute,savings-plans-ec2instance,savings-plans-sagemaker,savings-plans-database).savingsplans,savings-plans,sp) fan out to all four plan types.