docs: update contrib documentation

[mrsimonemms]

Description

Add some contributor documentation, thanks to @MartinLoeper for asking the question

Related Issue(s)

Fixes #

How to test

[mrsimonemms]

Hi @MartinLoeper, can I get your thoughts on these contributor docs please?

[MartinLoeper]

This looks good! I did the exact steps for Testing in the DevPod ecosystem with one addition: I created the provider.yaml using the build.sh script and replaced the paths in the binaries section with local paths. That way I was able to install the provider using the devpod cli. That is maybe a bit easier than moving the binary around.

Anyway, my issue was the following: when running devpod up, the machine tried to pull the agent binary from the location specified in the provider.yaml. That means, it would not use the binary you moved right? It seemed like the machine is downloading the agent binary from gh releases instead of pulling it via ssh connection. Is that the case?

[MartinLoeper]

Maybe you should add that the paths might differ when opening the workspace in a devcontainer?
As far as I understand, I have to either use the devpod cli inside the devcontainer or download the new binary from the devcontainer onto the host and exec the given commands on the host.

[mrsimonemms]

@MartinLoeper not sure. I did some work last night where I needed to use the GUI/CLI and this process worked for me.

I don't know much about the Agent, except this line in the GUI's Settings -> General: