Skip to content

DOC-1183 fix formatting - #252

Merged
micheleRP merged 4 commits into
mainfrom
DOC-1183-fix-formatting
Apr 5, 2025
Merged

DOC-1183 fix formatting#252
micheleRP merged 4 commits into
mainfrom
DOC-1183-fix-formatting

Conversation

@micheleRP

@micheleRP micheleRP commented Apr 5, 2025

Copy link
Copy Markdown
Contributor

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1183
Review deadline:

Page previews

https://deploy-preview-252--rp-cloud.netlify.app/redpanda-cloud/get-started/cluster-types/byoc/aws/create-byoc-cluster-aws/#prerequisites

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@micheleRP
micheleRP requested a review from a team as a code owner April 5, 2025 02:59
@hyperlint-ai-deprecated

Copy link
Copy Markdown
Contributor

PR Change Summary

Fixed formatting issues and clarified prerequisites for deploying BYOC clusters on AWS.

  • Updated prerequisites for AWS BYOC cluster deployment
  • Removed duplicate information regarding AWS IAM policies
  • Improved clarity in the instructions for AWS authentication

Modified Files

  • modules/get-started/pages/cluster-types/byoc/aws/create-byoc-cluster-aws.adoc

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@netlify

netlify Bot commented Apr 5, 2025

Copy link
Copy Markdown

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 37bf678
🔍 Latest deploy log https://app.netlify.com/sites/rp-cloud/deploys/67f0a1308c53200008ed9fc2
😎 Deploy Preview https://deploy-preview-252--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kbatuigas kbatuigas left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No blockers


* A minimum version of Redpanda `rpk` v24.1. See xref:manage:rpk/rpk-install.adoc[].
* The AWS variables necessary to authenticate. Use either:
* The user authenticating to AWS has `AWSAdministratorAccess` access to create the IAM policies specified in xref:security:authorization/cloud-iam-policies.adoc[AWS IAM policies].

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
* The user authenticating to AWS has `AWSAdministratorAccess` access to create the IAM policies specified in xref:security:authorization/cloud-iam-policies.adoc[AWS IAM policies].
* The user authenticating to AWS has `AWSAdministratorAccess` permission to create the IAM policies specified in xref:security:authorization/cloud-iam-policies.adoc[AWS IAM policies].

If we change it to "AWSAdministratorAccess permissions" would that make it less accurate?

@micheleRP micheleRP Apr 5, 2025

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.

@david-yu is this change OK (this PR is just to fix formatting I missed!):
"The user authenticating to AWS has access to the AWSAdministratorAccess policy to create..."

@Feediver1 Feediver1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Lgtm

@micheleRP
micheleRP merged commit f2306cc into main Apr 5, 2025
@micheleRP
micheleRP deleted the DOC-1183-fix-formatting branch April 5, 2025 23:22
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.

3 participants