Skip to content

Commit

Permalink
Update README and GitHub templates
Browse files Browse the repository at this point in the history
Signed-off-by: Jean du Plessis <[email protected]>
  • Loading branch information
jeanduplessis committed Aug 21, 2024
1 parent a3ff591 commit 77df30f
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 57 deletions.
11 changes: 5 additions & 6 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 GCP 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 GCP Provider!
# Thank you for helping to improve this provider!
- If you're not currently using the most recent version of the Upbound Official GCP 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 Expand Up @@ -103,4 +103,3 @@ body:
description: Any additional information you want to add, related issue(s), pull requests, document references, situations specific to your environment, etc.
validations:
required: false

12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
name: Feature Request
about: Help us make Official GCP Provider more useful
about: Help us make this provider more useful
labels: enhancement,needs:triage
title:
---
<!--
Thank you for helping to improve Official GCP 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 @@ -19,7 +18,8 @@ Leading with this context helps frame the feature request so we can ensure we
implement it sensibly.
--->

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

<!--
Let us know how you think Official GCP Provider could help with your use case.
-->
Let us know how you think could help with your use case.
-->
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/new_resource_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
name: New Resource Request
about: Help us know what resource you need is missing.
labels: new-resource
title: "Request for `gcp_instance` resource"
title: "Request for `INSERT NAME` resource"
---
<!--
Thank you for helping to improve Official GCP 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.
-->

### What resource do you need?

Terraform Resource Name:
Terraform Resource Name:
<!--
Please let us know the name of the resource you need.
-->
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 GCP Provider!
Please read through https://git.io/fj2m9 if this is your first time opening a
Official GCP 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 GCP 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
58 changes: 21 additions & 37 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 Provider GCP
# Upjet-based Crossplane provider for GCP

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

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

</div>

Provider GCP is a [Crossplane](https://crossplane.io/) provider that
Provider Upjet-GCP 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 the
generation tools and exposes XRM-conformant managed resources for the
GCP API.

## Getting Started

Follow the quick start guide [here](https://marketplace.upbound.io/providers/upbound/provider-gcp/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-gcp/latest/managed-resources).
Follow the quick start
guide [here](https://marketplace.upbound.io/providers/upbound/provider-family-azure/latest/docs/quickstart).

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)
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-family-azure/latest/managed-resources).

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).

### Add a New Resource

Follow the guide [here](https://github.com/crossplane/upjet/blob/v0.10.0/docs/add-new-resource-short.md).

### Local Development

1. Check out the provider repo, crossplane-contrib/provider-upjet-gcp, and go to the project
directory on your local machine.

2. Do the necessary changes locally and please make sure you have comitted all of them.

3. Run the `make load-pkg` command for family providers as follows.
Follow the Upjet guide
for [adding new resources](https://github.com/crossplane/upjet/blob/main/docs/adding-new-resource.md).

If you want to build any of the family resource providers (e.g., `provider-gcp-cloudplatform`, `provider-gcp-container`), you can do:
## Getting help

```shell
make load-pkg PROVIDERS="cloudplatform container" REPO="index.docker.io/<your-dockerhub-org>"
```
*Note: Installable images for the family config provider will be created by default.*

For more information, follow the guide [here](https://marketplace.upbound.io/providers/upbound/provider-family-gcp/latest/docs/development).

## Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please
open an [issue](https://github.com/crossplane-contrib/provider-upjet-gcp/issues/new/choose).

## Contact
For filing bugs, suggesting improvements, or requesting new resources or features, please
open an [issue](https://github.com/crossplane-contrib/provider-upjet-azure/issues/new/choose).

For general help on using the provider consider asking the Crossplane community in the
[#upjet-provider-gcp](https://crossplane.slack.com/archives/C05E7EVM459) channel in
[Crossplane Slack](https://slack.crossplane.io)

## Licensing

Provider GCP is under [the Apache 2.0 license](LICENSE) with [notice](NOTICE).
## License

The provider is released under the [the Apache 2.0 license](LICENSE) with [notice](NOTICE).

0 comments on commit 77df30f

Please sign in to comment.