github.com/SamarSidharth/kpt@v0.0.0-20231122062228-c7d747ae3ace/package-examples/_template/README.md (about) 1 # package-name 2 3 Short description about the exact purpose and end goal of this example. 4 5 ## Steps 6 7 This section should list all the steps needed to achieve the end goal. You may modify the steps according to your example. 8 9 1. [Fetch the package](#fetch-the-package) 10 2. [View the package contents](#view-the-package-contents) 11 3. [Configure functions](#configure-functions) 12 4. [Render the declared values](#render-the-declared-values) 13 5. [Apply the package](#apply-the-package) 14 15 ### Fetch the package 16 17 Describe the steps and exact commands needed to fetch this package onto local. 18 19 ### View the package contents 20 21 Describe how users can inspect the package contents. This could be using `kpt pkg tree` or directly opening files etc. 22 23 ### Configure functions 24 25 Describe the exact configuration which should be provided by users. This step usually requires users to declare 26 the desired functions and their values. Provide the function snippets to be added to Kptfile. 27 28 ### Render the declared values 29 30 This step should describe the process and exact steps to render the declared values. 31 32 ### Apply the package 33 34 This step should describe the process and exact commands needed to deploy the resources to a live cluster.