From 52cdcc2a3b1a81abc54ef1b8b53035e0cf6e918b Mon Sep 17 00:00:00 2001
From: Julien Pivotto <roidelapluie@inuits.eu>
Date: Wed, 22 Jul 2020 00:07:33 +0200
Subject: [PATCH] Add a check-list for new SD's (#7634)

Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
---
 discovery/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/discovery/README.md b/discovery/README.md
index 060c7d52c8..4c012c8d82 100644
--- a/discovery/README.md
+++ b/discovery/README.md
@@ -216,4 +216,16 @@ If all the targets in a group go away, we need to send the target groups with em
 ```
 down the channel.
 
+### New Service Discovery Check List
+
+Here are some non-obvious parts of adding service discoveries that need to be verified:
+
+- Check for `nil` SDConfigs in `discovery/config/config.go`.
+- Validate that discovery configs can be DeepEqualled by adding them to
+  `config/testdata/conf.good.yml` and to the associated tests.
+- If there is a TLSConfig or HTTPClientConfig, add them to
+  `resolveFilepaths` in `config/config.go`.
+- List the service discovery in both `<scrape_config>` and
+  `<alertmanager_config>` in `docs/configuration/configuration.md`.
+
 <!-- TODO: Add best-practices -->