diff --git a/docs/stack-templates-overview.md b/docs/stack-templates-overview.md index 961ae6f7..81c992f9 100644 --- a/docs/stack-templates-overview.md +++ b/docs/stack-templates-overview.md @@ -6,7 +6,7 @@ A stack template is a `yaml` file that tells Cluster.dev which units to run and how. It is a core Cluster.dev resource that makes for its flexibility. Stack templates use Go template language to allow you customise and select the units you want to run. -The stack template's config files are stored within the stack template directory that could be located either locally or in a Git repo. Cluster.dev reads all _./*.yaml files from the directory (non-recursively), renders a stack template with the project's data, parse the `yaml` file and loads [units](https://docs.cluster.dev/units-overview/) - the most primitive elements of a stack template. +The stack template's config files are stored within the stack template directory that could be located either locally or in a Git repo. Cluster.dev reads all _./*.yaml files from the directory (except for the yaml/yml files specified within the [.cdevignore](#cdevignore)), renders a stack template with the project's data, parse the `yaml` file and loads [units](https://docs.cluster.dev/units-overview/) - the most primitive elements of a stack template. A stack template represents a `yaml` structure with an array of different invocation units. Common view: diff --git a/docs/structure-project.md b/docs/structure-project.md index 0984d01f..08575cf7 100644 --- a/docs/structure-project.md +++ b/docs/structure-project.md @@ -5,6 +5,8 @@ Project is a storage for variables related to all stacks. It is a high-level abs File: `project.yaml`. *Optional*. Represents a set of configuration options for the whole project. Contains global project variables that can be used in other configuration objects, such as backend or stack (except of `secrets`). Note that the `project.conf` file is not rendered with the template and you cannot use template units in it. +The [`.cdevignore`](https://docs.cluster.dev/stack-templates-overview/#cdevignore) file in the project dir indicates that the yaml/yml files it contains will be ignored during cdev configs. + Example of `project.yaml`: ```yaml