diff --git a/README.rst b/README.rst index ea09912c..ab6abf7e 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,14 @@ -===== -fault -===== +===================== +Fault Management (FM) +===================== +The starlingx/fault repository handles Fault Management (FM) services [1]_, and +provides the fm command-line interface (CLI) [2]_. -StarlingX Fault Management +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 [3]_. + +References +========== +.. [1] https://docs.starlingx.io/api-ref/fault +.. [2] https://docs.starlingx.io/cli_ref/fm.html +.. [3] https://opendev.org/starlingx/manifest.git