From 5037c2ad3baa0c3d0a5d91d56c3af27bd6873d4f Mon Sep 17 00:00:00 2001 From: Roger Ferraz Date: Tue, 11 Jul 2023 12:22:54 -0300 Subject: [PATCH] starlingx/config README improvement This story shall update the README file of a few most used StarlingX repos. Test Plan: N/A Story: 2010814 Task: 48352 Change-Id: I73075a329d01476f2770e61ea5443b8ed98f0a42 Signed-off-by: Roger Ferraz --- README.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 38b6ccba95..0a1f1a39fb 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,16 @@ -========== -stx-config -========== +====== +config +====== +The starlingx/config repository handles the StarlingX configuration management +services. -StarlingX Configuration Management +Its key component is the System Inventory Service (Sysinv), which provides the +system command-line interface (CLI) [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/cli_ref/system.html +.. [2] https://opendev.org/starlingx/manifest.git