chore/nanocl: substate guide

next-hat · May 4, 2024 · 4596b4d · 4596b4d
1 parent 67164ef
commit 4596b4d
Show file tree

Hide file tree

Showing 5 changed files with 193 additions and 180 deletions.
diff --git a/docs/guides/nanocl/advanced-usage/sub-state.md b/docs/guides/nanocl/advanced-usage/sub-state.md
diff --git a/docs/guides/nanocl/advanced-usage/substate.md b/docs/guides/nanocl/advanced-usage/substate.md
@@ -0,0 +1,20 @@
+---
+title: SubState - Nanocl
+description: Use substate in your statefile.
+keywords: [documentation, nanocl, guides, get started, configuration, state, file, config, yaml, yml, statefile, substate]
+image: /img/logo.webp
+sidebar_label: SubState
+---
+
+import StatefileBlock from '@site/src/components/statefile_block';
+
+# SubState
+
+You can require other Statefiles in your Statefile using the `SubStates` key.
+
+This is useful if you need to reuse a statefile in multiple places.
+Or in a mono-repository settings to have a single source of truth for your state.
+
+There is an example of how to use it:
+
+<StatefileBlock example="advanced/substate.yml" />
diff --git a/examples/advanced/substate.yml b/examples/advanced/substate.yml