From dedf6569b6084e25515a449ea2266a394538fb52 Mon Sep 17 00:00:00 2001 From: Jean du Plessis Date: Wed, 21 Aug 2024 16:31:36 +0200 Subject: [PATCH] Update README and GitHub templates (#1465) --- .github/ISSUE_TEMPLATE/bug_report.yaml | 10 ++--- .github/ISSUE_TEMPLATE/feature_request.md | 13 +++--- .../ISSUE_TEMPLATE/new_resource_request.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 8 ++-- README.md | 43 ++++++++++--------- catalog-info.yaml | 24 ----------- docs/family/Configuration.md | 10 ++--- 7 files changed, 43 insertions(+), 67 deletions(-) delete mode 100644 catalog-info.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 3938a48516..a10e5ed376 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -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 @@ -20,7 +20,7 @@ body: options: - label: I have searched the existing issues required: true - + - type: textarea id: affected attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 33853d037e..1f8232670e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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: --- + -### How could Official AWS Provider help solve your problem? +### What could help solve your problem? + diff --git a/.github/ISSUE_TEMPLATE/new_resource_request.md b/.github/ISSUE_TEMPLATE/new_resource_request.md index 388b36c9e5..d49cdb2702 100644 --- a/.github/ISSUE_TEMPLATE/new_resource_request.md +++ b/.github/ISSUE_TEMPLATE/new_resource_request.md @@ -5,7 +5,7 @@ labels: new-resource title: "Request for `INSERT RESOURCE NAME` resource" --- @@ -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: diff --git a/README.md b/README.md index ecdb98ae68..e4770b073b 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ SPDX-FileCopyrightText: 2023 The Crossplane Authors SPDX-License-Identifier: CC-BY-4.0 --> -# Official AWS Provider +# Upjet-based Crossplane provider for AWS -
+
![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) @@ -17,39 +17,42 @@ SPDX-License-Identifier: CC-BY-4.0
-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= 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 @@ -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). diff --git a/catalog-info.yaml b/catalog-info.yaml deleted file mode 100644 index b4fdb39123..0000000000 --- a/catalog-info.yaml +++ /dev/null @@ -1,24 +0,0 @@ -# SPDX-FileCopyrightText: 2024 The Crossplane Authors -# -# SPDX-License-Identifier: Apache-2.0 - -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - name: provider-aws - description: "Official AWS Provider for Crossplane by Upbound" - links: - - url: https://github.com/upbound/provider-aws/blob/main/docs/Quickstart.md - title: Provider AWS Quickstart - - url: https://marketplace.upbound.io/providers/upbound/provider-family-aws/latest - title: Provider AWS Family Marketplace - - url: https://marketplace.upbound.io/providers/upbound/provider-aws/latest - title: Provider AWS Marketplace - annotations: - github.com/project-slug: upbound/provider-aws -spec: - type: service - lifecycle: production - owner: team-extensions - dependsOn: - - component:default/upjet diff --git a/docs/family/Configuration.md b/docs/family/Configuration.md index 87aea0b8a9..ed40a2ac6a 100644 --- a/docs/family/Configuration.md +++ b/docs/family/Configuration.md @@ -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 @@ -48,7 +47,6 @@ metadata: name: provider-aws-s3 spec: package: xpkg.upbound.io/upbound/provider-aws-s3: -EOF ``` Define the `provider-aws-s3` version with `spec.package`. @@ -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 @@ -452,7 +450,7 @@ used by the Kubernetes service account. First, use `kubectl describe service-account -n upbound-system` to get the ARN value. -```yaml +```shell $ kubectl describe service-account \ my-upbound-sa \ -n upbound-system