From 9520f121b7c5630ce125871ecffadaba6a565d64 Mon Sep 17 00:00:00 2001
From: Mark Nuzzo <mnuzzo@gitlab.com>
Date: Tue, 6 Feb 2024 20:34:44 +0000
Subject: [PATCH] Adding note for README.md component
---
doc/ci/components/index.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/doc/ci/components/index.md b/doc/ci/components/index.md
index 0b2d2122bc1b..3980077cbc61 100644
--- a/doc/ci/components/index.md
+++ b/doc/ci/components/index.md
@@ -82,6 +82,9 @@ The repository must contain:
- In sub-directories containing `template.yml` files as entry points, for components
that bundle together multiple related files. For example, `templates/secret-detection/template.yml`.
+NOTE:
+Optionally, each component can also have its own `README.md` file that provides more detailed information, and can be linked from the top-level `README.md` file. This helps to provide a better overview of your component project and how to use it.
+
You should also:
- Configure the project's `.gitlab-ci.yml` to [test the components](#test-the-component)
--
GitLab