vmware-tanzu / community-edition

VMware Tanzu Community Edition is no longer an actively maintained project. Code is available for historical purposes only.
https://tanzucommunityedition.io/
Apache License 2.0
1.33k stars 307 forks source link

Fix Docs on package-management #2222

Closed vrabbi closed 2 years ago

vrabbi commented 2 years ago

Description

on the package management documentation it states that values files should be in YTT format however from my understanding this is exactly the opposite. Kapp Controller does not support YTT annotated files as the secret unless setting a specific annotation which tanzu CLI does not set. the current wording is: "Note: Value files are expected to use ytt syntax. Please refer to the Carvel ytt documentation for further details"

This should be: Note: Value files are expected to be plain YAML and not YTT Data Values files.

Location

https://tanzucommunityedition.io/docs/latest/package-management/

Additional Context

hopefully it will be possible in the future in tanzu CLI to also allow passing a YTT data values file or an overlay file and have tanzu cli manage the addition of the needed annotations but till then this should be fixed in the docs so as to not confuse users.

joshrosso commented 2 years ago

Yup, great catch @vrabbi !