docs: debugging information added

[richardcase]

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Documentation added on how to debug CAPZ using tilt.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #588

TODOs:

• squashed commits
• includes documentation
• adds unit tests

Release note:

Added documentation on debugging using Tilt.

[mboersma]

This also fixes #1801.

[mboersma]

/lgtm

[mboersma]

This is great, thanks @richardcase!

By coincidence, I actually started making similar changes to enable debugging like this in the CAPZ-only setup. Would that also be useful, or should we just stick with CAPI's debugging configuration?

[jackfrancis]

/lgtm

[CecileRobertMichon]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CecileRobertMichon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [CecileRobertMichon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[richardcase]

This is great, thanks @richardcase!

By coincidence, I actually started making similar changes to enable debugging like this in the CAPZ-only setup. Would that also be useful, or should we just stick with CAPI's debugging configuration?

@mboersma - i think we must have both seen the stale notification. It reminded me i hadn't done it. I like the consistency that the CAPI debug configuration gives as i can use that for CAPZ, CAPA, core etc. But guessing if there is benefit to something specific to CAPZ that could be be an addition?

[mboersma]

Benefits to having a CAPZ-specific debugging configuration for Tilt would be convenience and keeping the project self-contained (although we document the CAPI+CAPZ debugging configuration already, obviously). But I'm not sure that outweighs the added complexity in CAPZ's Tiltfile, and it may be preferable to have one official way to debug CAPZ, which you have documented.

So I think I've talked myself out of it, but if you or anyone reading this sees more value in having a debugging configuration for the "Tilt with CAPZ" developer story, please say so. I'll keep the changes around.