Add development guide

[adamconnelly]

I've added a new document with information about how to build and test Promitor, along with an overview of the repository layout.

Fixes #484

[adamconnelly]

@tomkerkhove I'm not sure if this is quite what you're looking for, but I figured it's a starting point at least.

I've left a TODO about the deploy directory because I'm not quite sure what it's for, so if you can give me an outline of it I can update that.

[tomkerkhove]

Looks good, thanks man!

[tomkerkhove]

One thing we could add is how to build the Docker image outside of VS.

1. Navigate to /src
2. Run docker build . --file .\Promitor.Scraper.Host\Dockerfile --tag promitor --no-cache should work

[adamconnelly]

One thing we could add is how to build the Docker image outside of VS.

1. Navigate to /src
2. Run docker build . --file .\Promitor.Scraper.Host\Dockerfile --tag promitor --no-cache should work

Ok - I've added that.

What we might want to consider for future is making it easier to build and deploy the chart locally. For example, if we tag the image with same same tag referenced in the Helm chart, you can use your local image instead of having to pull it from the docker repo while doing local dev.

So we could create a values.local.yaml file that sets the tag to tomkerkhove/promitor-agent-scraper:local, and use that in the docker build command, then specify --values values.local.yaml when running the helm upgrade / install command. We do something pretty similar at work for running containers in a local cluster for development.

[tomkerkhove]

One thing we could add is how to build the Docker image outside of VS.

1. Navigate to /src
2. Run docker build . --file .\Promitor.Scraper.Host\Dockerfile --tag promitor --no-cache should work

Ok - I've added that.

What we might want to consider for future is making it easier to build and deploy the chart locally. For example, if we tag the image with same same tag referenced in the Helm chart, you can use your local image instead of having to pull it from the docker repo while doing local dev.

So we could create a values.local.yaml file that sets the tag to tomkerkhove/promitor-agent-scraper:local, and use that in the docker build command, then specify --values values.local.yaml when running the helm upgrade / install command. We do something pretty similar at work for running containers in a local cluster for development.

Would you mind opening an issue for this please? It's not fully clear to me what you are suggesting but don't want to block this PR on it!

[tomkerkhove]

Thanks!

[adamconnelly]

Would you mind opening an issue for this please? It's not fully clear to me what you are suggesting but don't want to block this PR on it!

No problem - it's really not a big deal, and it's not really related to this PR. It'll be easier for me to create an example to explain it.