Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add preferred provider repository naming #123

Merged
merged 1 commit into from
Nov 7, 2022
Merged

docs: add preferred provider repository naming #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/generating-a-provider.md
View file
Open in desktop
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