doc/entities.md in power_stencil-0.6.3 vs doc/entities.md in power_stencil-0.7.0
- old
+ new
@@ -85,23 +85,23 @@
It provides a lot of information about the project, but let's focus on the `Entities` and `Available entity types` parts of the report.
You can see here above that only 6 types of entity are defined by default in a brand new created `PowerStencil` project. You can find them below with some of their core features:
-| entity type | system | persisted | buildable | has associated files |
-|-------------|:------:|:---------:|:---------:|:--------------------:|
+| entity type | system | persisted | buildable | provides templates |
+|-------------|:------:|:---------:|:---------:|:------------------:|
|base_entity||X
|entity_override||X
-|plugin_definition|X
+|plugin_definition|X|||X
|process_descriptor||X
|project_config|X
|simple_exec||X|X|X
-- You should not care about _system_ entities unless you are developing features in `PowerStencil`.
-- By default any entity type, including those you may create, is _persistent_.
-- A _buildable_ entity is an entity you can run `power_stencil build` against. More about this in the [builds] part.
-- When an entity _has associated files_, it means its [templates] are in `<project_root>/<entity_type>/<entity_name>` folder. We'll talk about this more in depth in the [templates] and [builds] part.
+- You should not care about _system_ entity types unless you are developing features in `PowerStencil`. You cannot instantiate any of them like others.
+- By default any entity type, including those you may instantiate, is _persistent_.
+- A _buildable_ entity type is an entity type you can run `power_stencil build` against its instantiated entities. More about this in the [builds] part.
+- When an entity type _provides templates_, it means its [templates] will generated in `<project_root>/templates/<entity_type>/<entity_name>` folder when you create an entity of this type. We'll talk about this more in depth in the [templates] and [builds] part.
On top of this `power_stencil info` brings you information about the actual Ruby classes implementing those entity types.
For a typical project which goal is only to generate some files from templates, the only entity types you may need are:
@@ -352,12 +352,12 @@
Of course you can then delete the entity like any other...
```shell
$ power_stencil delete base_entity/dev_entity --auto
Deleted 'base_entity/dev_entity'
-
```
+:hand: As opposed to versioned entities, the templates are not generated in `<project_root>/templates/<entity_type>/<entity_name>` but instead in `<project_root>/unversioned-templates/<entity_type>/<entity_name>`. Anything below `<project_root>/unversioned-templates`, as its name suggests will not be versioned...
## Updating entities
Not so much to say about updating entities. It works exactly the same way as the `power_stencil create`.