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