Skip to content

Commit 3f07469

Browse files
authored
Update README.yaml to restructure usage and references
Replaced usage section with structured references in README.yaml
1 parent b730a30 commit 3f07469

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.yaml

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ description: |-
66
This component creates a Helm release for
77
[actions-runner-controller](https://github.com/actions-runner-controller/actions-runner-controller) on an EKS cluster.
88
9-
## Usage
10-
9+
usage: |-
1110
**Stack Level**: Regional
1211
1312
Once the catalog file is created, the file can be imported as follows.
@@ -488,14 +487,22 @@ description: |-
488487
<!-- prettier-ignore-start -->
489488
<!-- prettier-ignore-end -->
490489
491-
## References
492-
493-
- [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/eks/actions-runner-controller) -
494-
Cloud Posse's upstream component
495-
- [alb-controller](https://artifacthub.io/packages/helm/aws/aws-load-balancer-controller) - Helm Chart
496-
- [alb-controller](https://github.com/kubernetes-sigs/aws-load-balancer-controller) - AWS Load Balancer Controller
497-
- [actions-runner-controller Webhook Driven Scaling](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/docs/detailed-docs.md#webhook-driven-scaling)
498-
- [actions-runner-controller Chart Values](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/charts/actions-runner-controller/values.yaml)
490+
references:
491+
- name: cloudposse-terraform-components
492+
url: https://github.com/orgs/cloudposse-terraform-components/repositories
493+
description: Cloud Posse's upstream component
494+
- name: alb-controller
495+
url: https://artifacthub.io/packages/helm/aws/aws-load-balancer-controller
496+
description: Helm Chart
497+
- name: alb-controller
498+
url: https://github.com/kubernetes-sigs/aws-load-balancer-controller
499+
description: AWS Load Balancer Controller
500+
- name: actions-runner-controller Webhook Driven Scaling
501+
url: https://github.com/actions-runner-controller/actions-runner-controller/blob/master/docs/detailed-docs.md#webhook-driven-scaling
502+
description:
503+
- name: actions-runner-controller Chart Values
504+
url: https://github.com/actions-runner-controller/actions-runner-controller/blob/master/charts/actions-runner-controller/values.yaml
505+
description:
499506
tags:
500507
- component/eks/actions-runner-controller
501508
- layer/github

0 commit comments

Comments
 (0)