diff --git a/TILE_AUTHOR_GUIDE.md b/TILE_AUTHOR_GUIDE.md index 11cbfd5b4..4500d313f 100644 --- a/TILE_AUTHOR_GUIDE.md +++ b/TILE_AUTHOR_GUIDE.md @@ -46,9 +46,11 @@ It also expects these files: If you follow conventions you may experience the sweetness of running `kiln bake` without flags and getting a tile. Again, see [hello-tile](https://github.com/crhntr/hello-tile) (non-VMware employees) or the TAS repo (VMware employees) for tile source code that kiln "just works" with. + #### Starting from scratch -The following code does not create a working tile; it creates conventional defaults to start/standardize your tile authorship journey with Kiln. +The following code bootstraps Product template parts from an empty directory working tile; it creates conventional defaults to start/standardize your tile authorship journey with Kiln. +It does not generate source for a working tile. ```shell # Make directories and keep them around mkdir -p bosh_variables forms instance_groups jobs migrations properties releases runtime_configs @@ -84,6 +86,13 @@ form_types: [] EOF ``` +
+PPE TODO + +Create a `kiln init` command that actually makes a working tile. + +
+ ## Authoring Product Template Parts A tile is a zip file with a ".pivotal" suffix. @@ -96,7 +105,7 @@ Kiln expects certain directories to contain Product Template (metadata) parts. - `./forms` should contain YAML files that have [form_types](https://docs.pivotal.io/tiledev/2-9/property-template-references.html#form-properties) - `./instance_groups` should contain YAML files that have [job_types](https://docs.pivotal.io/tiledev/2-9/property-template-references.html#job-types) - `./jobs` should contain YAML files that have [job templates](https://docs.pivotal.io/tiledev/2-9/property-template-references.html#job-template) and may contain a [job mainfest](https://docs.pivotal.io/tiledev/2-9/property-template-references.html#job-manifest) -- `./migrations` should contain Javascript files that are migrations (TODO add link to ref) +- `./migrations` should contain Javascript files that are migrations (TODO add link to specification) - `./properties` should contain YAML files that have [property-blueprints](https://docs.pivotal.io/tiledev/2-9/property-template-references.html#property-blueprints) - `./releases` should be an empty directory (maybe containing .gitkeep) and will be where Kiln writes BOSH Release Tarballs - `./runtime_configs` should contain YAML files that have [runtime configs](https://docs.pivotal.io/tiledev/2-9/runtime-config.html)