Skip to content

Commit

Permalink
Update README and GitHub templates (#1465)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeanduplessis committed Aug 21, 2024
1 parent 4485b44 commit dedf656
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 67 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: Bug Report
description: Help us diagnose and fix bugs in Official AWS Provider
labels: bug,needs:triage
description: Help us diagnose and fix bugs in this provider
labels: ["bug","needs:triage"]
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
# Thank you for helping to improve Official AWS Provider!
# Thank you for helping to improve this provider!
- If you're not currently using the most recent version of the Upbound Official AWS Provider, we recommend upgrading. Your issue might have already been addressed in the latest release.
- If you're not currently using the most recent version of the provider, we recommend upgrading. Your issue might have already been addressed in the latest release.
- type: checkboxes
id: existing_issue
Expand All @@ -20,7 +20,7 @@ body:
options:
- label: I have searched the existing issues
required: true

- type: textarea
id: affected
attributes:
Expand Down
13 changes: 7 additions & 6 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
name: Feature Request
about: Help us make Official AWS Provider more useful
about: Help us make this provider more useful
labels: enhancement,needs:triage
title:
---

<!--
Thank you for helping to improve Official AWS Provider!
Thank you for helping to improve this provider!
Please be sure to search for open issues before raising a new one. We use issues
for bug reports and feature requests.
Expand All @@ -15,11 +15,12 @@ for bug reports and feature requests.

<!--
Please tell us a little about your use case - it's okay if it's hypothetical!
Leading with this context helps frame the feature request so we can ensure we
Leading with this context helps frame the feature request, so we can ensure we
implement it sensibly.
--->

### How could Official AWS Provider help solve your problem?
### What could help solve your problem?

<!--
Let us know how you think Official AWS Provider could help with your use case.
Let us know how you think could help with your use case.
-->
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/new_resource_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ labels: new-resource
title: "Request for `INSERT RESOURCE NAME` resource"
---
<!--
Thank you for helping to improve Official AWS Provider!
Thank you for helping to improve this provider!
Please be sure to search for open issues before raising a new one. We use issues
for bug reports and feature requests.
Expand Down
8 changes: 3 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
Thank you for helping to improve Official AWS Provider!
Please read through https://git.io/fj2m9 if this is your first time opening a
Official AWS Provider pull request. Find us in https://crossplane.slack.com
pull request to this repo. Find us in https://crossplane.slack.com
if you need any help contributing.
-->

Expand All @@ -12,11 +10,11 @@ if you need any help contributing.
Briefly describe what this pull request does. Be sure to direct your
reviewers' attention to anything that needs special consideration.
We love pull requests that resolve an open Official AWS Provider issue. If yours does, you
We love pull requests that resolve an open issue. If yours does, you
can uncomment the below line to indicate which issue your PR fixes, for example
"Fixes #500":
-->

Fixes #

I have:
Expand Down
43 changes: 23 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ SPDX-FileCopyrightText: 2023 The Crossplane Authors <https://crossplane.io>
SPDX-License-Identifier: CC-BY-4.0
-->

# Official AWS Provider
# Upjet-based Crossplane provider for AWS

<div align="center">
<div style="text-align: center;">

![CI](https://github.com/crossplane-contrib/provider-upjet-aws/workflows/CI/badge.svg)
[![GitHub release](https://img.shields.io/github/release/crossplane-contrib/provider-upjet-aws/all.svg)](https://github.com/crossplane-contrib/provider-upjet-aws/releases)
Expand All @@ -17,39 +17,42 @@ SPDX-License-Identifier: CC-BY-4.0

</div>

Provider AWS is a [Crossplane](https://crossplane.io/) provider that is
Provider Upjet-AWS is a [Crossplane](https://crossplane.io/) provider that is
built using [Upjet](https://github.com/crossplane/upjet) code
generation tools and exposes XRM-conformant managed resources for
[Amazon AWS](https://aws.amazon.com/).

## Getting Started

Follow the quick start guide [here](https://marketplace.upbound.io/providers/upbound/provider-aws/latest/docs/quickstart).
Follow the quick start
guide [here](https://marketplace.upbound.io/providers/upbound/provider-aws/latest/docs/quickstart).

You can find a detailed API reference for all the managed resources with examples in the [Upbound Marketplace](https://marketplace.upbound.io/providers/upbound/provider-aws/latest/managed-resources).
You can find a detailed API reference for all the managed resources with examples in
the [Upbound Marketplace](https://marketplace.upbound.io/providers/upbound/provider-aws/latest/managed-resources).

For getting more information about resource consumption and monitoring
the upjet runtime, please see [Sizing Guide](https://github.com/crossplane/upjet/blob/v0.10.0/docs/sizing-guide.md)
and [Monitoring Guide](https://github.com/crossplane/upjet/blob/main/docs/monitoring.md)
For more information about monitoring the Upjet runtime, please
see [Monitoring Guide](https://github.com/crossplane/upjet/blob/main/docs/monitoring.md)

## Contributing

For the general contribution guide, see [Upjet Contribution Guide](https://github.com/crossplane/upjet/blob/main/CONTRIBUTING.md)
For the general contribution guide,
see [Upjet Contribution Guide](https://github.com/crossplane/upjet/blob/main/CONTRIBUTING.md)

If you'd like to learn how to use Upjet, see [Usage Guide](https://github.com/crossplane/upjet/tree/main/docs).

To build this provider locally and run it in a local Kubernetes cluster, run the
following to build the family provider (`config`) and `ec2`:
following to build the family config provider (`config`) and the sub-package you are working on e.g. `ec2`:

```shell
DOCKERHUB_ORG=<your-docker-name>
BUILD_ARGS="--load" XPKG_REG_ORGS_NO_PROMOTE="" XPKG_REG_ORGS="index.docker.io/$DOCKERHUB_ORG" make build.all publish BRANCH_NAME=main SUBPACKAGES="config ec2"
```

The `BRANCH_NAME` set to `main` (even though you might be on another branch) will
let make publish the images to your docker hub account.
The `BRANCH_NAME` is set to `main` (even though you might be on another branch) to allow
for the publishing of the images to your docker hub account.

To install the provider `provider-aws-ec2` into a local Kubernetes cluster, apply:
To install the provider, in this example `provider-aws-ec2`, into a local Kubernetes cluster with Crossplane already
installed, apply:

```yaml
apiVersion: pkg.crossplane.io/v1
Expand All @@ -62,18 +65,18 @@ spec:
### Add a New Resource
Follow the guide [here](https://github.com/crossplane/upjet/blob/v0.10.0/docs/add-new-resource-short.md).
Follow the Upjet guide
for [adding new resources](https://github.com/crossplane/upjet/blob/main/docs/adding-new-resource.md).
## Report a Bug
## Getting help
For filing bugs, suggesting improvements, or requesting new features, please
For filing bugs, suggesting improvements, or requesting new resources or features, please
open an [issue](https://github.com/crossplane-contrib/provider-upjet-aws/issues/new/choose).
## Contact
For general help on using the provider consider asking the Crossplane community in the
[#upjet-provider-aws](https://crossplane.slack.com/archives/C05E0UE46S2) channel in
[Crossplane Slack](https://slack.crossplane.io)
## Licensing
## License
Provider AWS is under [the Apache 2.0 license](LICENSE) with [notice](NOTICE).
The provider is released under the [the Apache 2.0 license](LICENSE) with [notice](NOTICE).
24 changes: 0 additions & 24 deletions catalog-info.yaml

This file was deleted.

10 changes: 4 additions & 6 deletions docs/family/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: Configuration
weight: 2
---

# AWS official provider-family documentation
Upbound supports and maintains the Upbound AWS official provider-family.
# Configuration

## Install the provider-family-aws
## Install the provider-family-aws provider
### Prerequisites
#### Upbound Up command-line
The Upbound Up command-line simplifies configuration and management of Upbound
Expand Down Expand Up @@ -48,7 +47,6 @@ metadata:
name: provider-aws-s3
spec:
package: xpkg.upbound.io/upbound/provider-aws-s3:<version>
EOF
```
Define the `provider-aws-s3` version with `spec.package`.
Expand Down Expand Up @@ -311,7 +309,7 @@ Verify the creation of the service account with the command `kubectl describe sa
created IAM role.

From the example service account named `my-upbound-sa`:
```yaml
```shell
$ kubectl describe sa \
-n upbound-system \
my-upbound-sa
Expand Down Expand Up @@ -452,7 +450,7 @@ used by the Kubernetes service account.
First, use `kubectl describe service-account <name> -n upbound-system` to get
the ARN value.
```yaml
```shell
$ kubectl describe service-account \
my-upbound-sa \
-n upbound-system
Expand Down

0 comments on commit dedf656

Please sign in to comment.