From d8b704472be1b1a3804e954455ea8df4ebf43c27 Mon Sep 17 00:00:00 2001 From: Roger Ferraz Date: Thu, 13 Jul 2023 12:29:41 -0300 Subject: [PATCH] starlingx/metal README improvement This story shall update the README file of a few most used StarlingX repos. Test Plan: N/A Story: 2010814 Task: 48378 Change-Id: I3323f10f9cd983a5ff12f846e4c14af8cebbbd2f Signed-off-by: Roger Ferraz --- README.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 30017961..2988e69e 100644 --- a/README.rst +++ b/README.rst @@ -2,4 +2,12 @@ metal ===== -StarlingX Bare Metal Management +The starlingx/metal repository handles StarlingX Bare Metal Management [1]_. + +This repository is not intended to be developed standalone, but rather as part +of the StarlingX Source System, which is defined by the StarlingX manifest [2]_. + +References +========== +.. [1] https://docs.starlingx.io/api-ref/metal +.. [2] https://opendev.org/starlingx/manifest.git