cluster-api-provider-oci icon indicating copy to clipboard operation
cluster-api-provider-oci copied to clipboard

Published 20 hours ago • verified publisher icon oracle

docs: add a simple local development guide

Open joekr opened this issue 3 years ago • 3 comments

What this PR does / why we need it: Simply adds a markdown doc for local development. I keep forgetting what the auth config and registry ENVs when doing development work

Which issue(s) this PR fixes: No open issues for this PR

joekr avatar Mar 09 '22 19:03 joekr

Can you please lint all your Markdown files using markdownlint, please.

Djelibeybi avatar Mar 11 '22 06:03 Djelibeybi

I suggest following the same layout as the AWS development guide: https://cluster-api-aws.sigs.k8s.io/development/development.html, i.e. start with explaining the prequisites, then set up the environment, then how to commit, etc.

Djelibeybi avatar Mar 11 '22 06:03 Djelibeybi

@Djelibeybi ended up moving the doc into the book like you pointed out and expanding upon the developer guide a bit.

joekr avatar Mar 11 '22 19:03 joekr