Skip to content

Commit

Permalink
Merge pull request #123 from sboschman/patch-1
Browse files Browse the repository at this point in the history
docs: add preferred provider repository naming
  • Loading branch information
muvaf authored Nov 7, 2022
2 parents c82119f + 9bb4dba commit d9f4624
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/generating-a-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ example organization name to be used.
## Generate

1. Generate a GitHub repository for the Crossplane provider by hitting the
"**Use this template**" button in [upjet-provider-template] repository.
"**Use this template**" button in [upjet-provider-template] repository. The preferred repository name is `provider-<name>` (e.g. `provider-github`), which is assumed by the `./hack/prepare.sh` script in step 3.
2. Clone the repository to your local and `cd` into the repository directory.
Fetch the [upbound/build] submodule by running the following:

Expand Down Expand Up @@ -342,4 +342,4 @@ Now let's test our generated resources.
[github_branch]: https://registry.terraform.io/providers/integrations/github/latest/docs/resources/branch
[this line in controller Dockerfile]: https://github.com/upbound/upjet-provider-template/blob/main/cluster/images/official-provider-template-controller/Dockerfile#L18-L26
[terraform-plugin-sdk]: https://github.com/hashicorp/terraform-plugin-sdk
[new-resource-short]: add-new-resource-short.md
[new-resource-short]: add-new-resource-short.md

0 comments on commit d9f4624

Please sign in to comment.