Skip to content

Align README.md content with other controllers. #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jjshanks
Copy link

@jjshanks jjshanks commented Jan 8, 2025

Based on intros in s3, iam, and rds controllers.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Based on intros in s3, iam, and rds controllers.
@ack-prow ack-prow bot requested review from a-hilaly and michaelhtm January 8, 2025 13:46
@ack-prow ack-prow bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jan 8, 2025
Copy link

ack-prow bot commented Jan 8, 2025

Hi @jjshanks. Thanks for your PR.

I'm waiting for a aws-controllers-k8s member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@jjshanks
Copy link
Author

@a-hilaly and @michaelhtm it's been 2 months since this was opened, just checking in on if you need anything else to proceed.

@michaelhtm
Copy link
Member

michaelhtm commented Mar 12, 2025

Hi @jjshanks, thanks for the contribution! Will merge soon.
/ok-to-test

Update: https://github.com/aws-controllers-k8s/ec2-controller/edit/main/README.md is written the same way as the REadME in this controller...

there are some inconsistencies i noticed between the controllers, i'm not sure if we should go back and update all.
What do you think @a-hilaly

@ack-prow ack-prow bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 12, 2025
Copy link

ack-prow bot commented Mar 12, 2025

@jjshanks: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
recyclebin-verify-attribution 14334b4 link false /test recyclebin-verify-attribution

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@a-hilaly
Copy link
Member

To me it looks like there is indeed a generation bug for recyclebin README. We definetely need to think about generating READMEs for all the controllers, and we can still merge this as is.

Copy link
Member

@a-hilaly a-hilaly left a comment

Choose a reason for hiding this comment

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

Thanks @jjshanks !

Copy link

ack-prow bot commented Mar 12, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: a-hilaly, jjshanks

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ack-prow ack-prow bot added the approved label Mar 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved ok-to-test Indicates a non-member PR verified by an org member that is safe to test.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants