Docs deviation: Config, ImageOverrides and --lock-output

[Zebradil]

kbld --lock-output produces a file with a resource of Config kind.
But in the docs I don't see a mention that kind: Config has overrides key.

I'd like to clarify which kind is preferable for overriding images: ImageOverrides or Config.

Here is a snippet I used for testing:

echo "image: postgres" | kbld -f - --lock-output /dev/fd/2 > /dev/null
resolve | final: postgres -> index.docker.io/library/postgres@sha256:8f7c3c9b61d82a4a021da5d9618faf056633e089302a726d619fa467c73609e4
apiVersion: kbld.k14s.io/v1alpha1
kind: Config
minimumRequiredVersion: 0.23.0
overrides:
- image: postgres
  newImage: index.docker.io/library/postgres@sha256:8f7c3c9b61d82a4a021da5d9618faf056633e089302a726d619fa467c73609e4
  preresolved: true

[cppforlife]

@Zebradil some time ago ive introduced Config kind which actually covers all the config (sources, destinations, etc.). since we want to be backwards compatible we will not remove dedicated kinds (e.g. Sources); however, going forward we will not be creating dedicated kinds. we should probably update docs to indicate that you can use kind Config for all configuration.

[Zebradil]

So, if I understand correctly, using Config kind is preferable. Thanks a lot!

(Not sure if I should close the issue or it'll be closed after docs update)

[pivotaljohn]

Leaving this open is perfect, @Zebradil; thank you.

@cppforlife does this match how you're thinking?:

1. in the main flow in the docs, replace all references to other configuration files (i.e. kind: Sources, kind: ImageDestinations, etc) with kind: Config
2. footnote in those various places that a deprecated way to express those configurations was by using those specific kinds.

[cppforlife]

updated https://github.com/vmware-tanzu/carvel-kbld/blob/develop/docs/config.md.