Skip to content

Commit

Permalink
updating the olm config file with proper documentation and examples (#12
Browse files Browse the repository at this point in the history
)

Issue #, if available:
- Fixes: aws-controllers-k8s/community#1970

Description of changes:
Updating the OLM config with proper info and examples. This ensures the bundle is created with proper `metadata.annotations.alm-examples`

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
  • Loading branch information
acornett21 authored Jan 3, 2024
1 parent 5de8793 commit 07fe1c4
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions olm/olmconfig.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ description: |-
**About Amazon Organizations**
{ADD YOUR DESCRIPTION HERE}
With AWS Organizations you can perform account management activities at scale by consolidating multiple AWS accounts into a single organization.
Consolidating accounts simplifies how you use other AWS services. You can leverage the multi-account management services available in AWS Organizations
with select AWS services to perform tasks on all accounts that are members of your organization.
**About the AWS Controllers for Kubernetes**
Expand All @@ -22,13 +24,11 @@ description: |-
This controller is a component of the [AWS Controller for Kubernetes](https://github.com/aws/aws-controllers-k8s)
project. This project is currently in **developer preview**.
samples:
- kind: ExampleCustomKind
spec: '{}'
- kind: SecondExampleCustomKind
- kind: OrganizationalUnit
spec: '{}'
maintainers:
- name: "organizations maintainer team"
email: "[email protected]"
links:
- name: Amazon Organizations Developer Resources
url: https://aws.amazon.com/Organizations/developer-resources/
url: https://aws.amazon.com/organizations/resources/

0 comments on commit 07fe1c4

Please sign in to comment.