Skip to content

Commit

Permalink
docs: update README.md with information about adding CRDs to PROJECT (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
pmalek authored Mar 27, 2024
1 parent 081a7ca commit eb54ade
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ detailed description of how to thoroughly use this project.
### Prerequisites

In order to build the operator you'll have to have Go installed on your machine.
In order to do so, follow the instructions on its website][go-dev-site].
In order to do so, follow the instructions on its website[go-dev-site].

### Build process

Expand All @@ -56,6 +56,14 @@ After this step has finished successfully you should see the operator's binary `
You can also run it directly via `make run` which will run the operator on your
machine against the cluster that you have configured via your `KUBECONFIG`.

### Adding new CRDs

Whenever you add a new CRD ensure that it is included in project's [`PROJECT`](./PROJECT) file.

This is necessary for creation of a bundle for external hubs like [Operator Hub's community operators][community-operators].

[community-operators]: https://github.com/k8s-operatorhub/community-operators/

## Seeking Help

Please search through the posts on the [discussions page][disc] as it's likely
Expand Down

0 comments on commit eb54ade

Please sign in to comment.