doc: explain that custom.yaml should be used for template customizati…

…on (#3353)
NetApp · Dec 5, 2024 · ca49d32 · ca49d32
1 parent 50485f3
commit ca49d32
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 9 deletions.
diff --git a/docs/configure-templates.md b/docs/configure-templates.md
@@ -1,8 +1,9 @@
-## Customization of templates
+## Templates customization
 
 This document covers how to use [Collector](configure-templates.md#collector-templates)
-and [Object](configure-templates.md#object-templates) templates to extend Harvest with `custom.yaml`.
-Customization of templates must follow the `custom.yaml` approach to avoid overwrite.
+and [Object](configure-templates.md#object-templates) templates to extend Harvest.
+Customization of templates should use the `custom.yaml` approach
+to avoid overwriting your changes when Harvest is upgraded, or you rerun the `generate` command.
 
 1. [How to add a new object template via custom.yaml](configure-templates.md#create-a-new-object-template)
 2. [How to extend an existing object template via custom.yaml](configure-templates.md#extend-an-existing-object-template)

diff --git a/docs/install/containers.md b/docs/install/containers.md
@@ -176,10 +176,13 @@ password: admin
 
 ### How do I add a new poller?
 
+Note: All of your template customizations should follow the custom.yaml approach
+mentioned in [template customization](../configure-templates.md#templates-customization),
+otherwise any changes you've made in the `conf` directory will be overwritten.
+
 1. Add poller to `harvest.yml`
-2. All your template customization must follow the custom.yaml approach as mentioned in [Customization of templates](../configure-templates.md#customization-of-templates), Else they would be overwritten.
-3. Regenerate compose file by running [harvest generate](#generate-a-docker-compose-for-your-pollers)
-4. Run [docker compose up](#start-everything), for example,
+2. Regenerate compose file by running [harvest generate](#generate-a-docker-compose-for-your-pollers)
+3. Run [docker compose up](#start-everything), for example,
 
 ```bash
 docker compose -f prom-stack.yml -f harvest-compose.yml up -d --remove-orphans

diff --git a/docs/install/harvest-containers.md b/docs/install/harvest-containers.md
@@ -63,10 +63,13 @@ docker compose -f harvest-compose.yml up -d --remove-orphans
 
 ### How do I add a new poller?
 
+Note: All of your template customizations should follow the custom.yaml approach
+mentioned in [template customization](../configure-templates.md#templates-customization),
+otherwise any changes you've made in the `conf` directory will be overwritten.
+
 1. Add poller to `harvest.yml`
-2. All your template customization must follow the custom.yaml approach as mentioned in [Customization of templates](../configure-templates.md#customization-of-templates), Else they would be overwritten.
-3. Regenerate compose file by running [harvest generate](#generate-a-docker-compose-for-your-pollers)
-4. Run [docker compose up](#start-everything), for example,
+2. Regenerate compose file by running [harvest generate](#generate-a-docker-compose-for-your-pollers)
+3. Run [docker compose up](#start-everything), for example,
 
 ```bash
 docker compose -f harvest-compose.yml up -d --remove-orphans