aws: documentation fixes#880
Conversation
Signed-off-by: Wesley Pettit <wppttt@amazon.com>
Signed-off-by: Wesley Pettit <wppttt@amazon.com>
Signed-off-by: Wesley Pettit <wppttt@amazon.com>
Signed-off-by: Wesley Pettit <wppttt@amazon.com>
lecaros
added
the
waiting-for-user
matthewfala
left a comment
matthewfala
left a comment
There was a problem hiding this comment.
They look great! Just one typo maybe
|
This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
|
This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
|
This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
|
@PettitWesley can you resolve the conflicts and I'll get this PR merged for you? |
|
@esmerel can you take a look at this PR? |
|
This one is tougher due to the interweaving of a couple of things in the cloudwatch page, I'll have to come back to this one. |
eschabell
removed
the
waiting-for-user
Signed-off-by: Eric D. Schabell <eric@schabell.org>
|
Warning Review limit reached
More reviews will be available in 13 minutes and 28 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR refines documentation across four Fluent Bit output plugin guides: CloudWatch, Firehose, Kinesis, and S3. Changes clarify configuration examples, improve ECR troubleshooting guidance consistency, and adjust section spacing for readability. ChangesOutput Plugin Documentation Improvements
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
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)
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. Comment |
|
@PettitWesley fixed all the conflicts. |
![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
🧹 Nitpick comments (2)
pipeline/outputs/s3.md (1)
618-618: ⚡ Quick winInconsistent wording with other AWS plugin docs.
This line uses "try signing in to public ECR" while
cloudwatch.md(line 410) andfirehose.md(line 169) both use "try logging into public ECR". Since this PR aims to improve consistency across AWS plugin documentation, consider using the same verb phrase across all files.📝 Suggested consistency fix
-If you see errors for image pull limits, try signing in to public ECR with your AWS credentials: +If you see errors for image pull limits, try logging into public ECR with your AWS credentials:🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@pipeline/outputs/s3.md` at line 618, The sentence in pipeline/outputs/s3.md uses "try signing in to public ECR" which is inconsistent with cloudwatch.md and firehose.md; update that exact line to use the same phrasing "try logging into public ECR" so wording matches the other AWS plugin docs and maintain consistency across documentation.pipeline/outputs/cloudwatch.md (1)
410-410: 💤 Low valueGrammar correction looks good, but consider consistency across files.
The grammar fix from "try log into" to "try logging into" is correct. However, note that
s3.mdline 618 uses "try signing in to" instead of "try logging into". For consistency across all AWS plugin documentation, consider using the same verb phrase.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@pipeline/outputs/cloudwatch.md` at line 410, Choose a consistent verb phrase for AWS plugin docs and update occurrences to match it: replace the fragment "try logging into" or "try signing in to" across documentation so all files use the same phrasing (pick one, e.g., "try signing in to"). Specifically search for the sentence variants in cloudwatch.md ("try logging into") and s3.md ("try signing in to") and make them identical across all AWS plugin docs, keeping surrounding punctuation and casing consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@pipeline/outputs/cloudwatch.md`:
- Around line 195-196: Replace the misleading introductory sentence "Recall that
the Kubernetes filter can add metadata which will look like the following:" with
a phrase that accurately introduces the YAML output configuration block that
follows (e.g., "Here's an example output configuration using the Kubernetes
metadata:") so the text correctly sets up the configuration template shown in
the subsequent lines; update the sentence near the existing Kubernetes metadata
discussion accordingly (the block that precedes the output configuration
template) to maintain clear context.
---
Nitpick comments:
In `@pipeline/outputs/cloudwatch.md`:
- Line 410: Choose a consistent verb phrase for AWS plugin docs and update
occurrences to match it: replace the fragment "try logging into" or "try signing
in to" across documentation so all files use the same phrasing (pick one, e.g.,
"try signing in to"). Specifically search for the sentence variants in
cloudwatch.md ("try logging into") and s3.md ("try signing in to") and make them
identical across all AWS plugin docs, keeping surrounding punctuation and casing
consistent.
In `@pipeline/outputs/s3.md`:
- Line 618: The sentence in pipeline/outputs/s3.md uses "try signing in to
public ECR" which is inconsistent with cloudwatch.md and firehose.md; update
that exact line to use the same phrasing "try logging into public ECR" so
wording matches the other AWS plugin docs and maintain consistency across
documentation.
🪄 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: 3e103f53-5b0a-4946-9fa2-15435d2d5b08
📒 Files selected for processing (4)
pipeline/outputs/cloudwatch.mdpipeline/outputs/firehose.mdpipeline/outputs/kinesis.mdpipeline/outputs/s3.md
💤 Files with no reviewable changes (1)
- pipeline/outputs/kinesis.md
- Restore opening ```yaml fence and pipeline: key removed in a prior edit,
which left the LocalStack YAML example rendering as plain text
- Remove informal 'Recall that...' sentence inserted before Kubernetes
record_accessor example
Applies to fluent#880
Signed-off-by: Eric D. Schabell <eric@schabell.org>
eschabell
left a comment
eschabell
left a comment
There was a problem hiding this comment.
@PettitWesley thanks for the docs PR, merging.
6 participants
Summary by CodeRabbit