starlingx
/
fault
Code Issues Proposed changes

starlingx/fault README improvement 

This story shall update the README file of a few most used StarlingX
repos.

Test Plan: N/A

Story: 2010814
Task: 48379

Change-Id: I98483245931c5d764c662f5283c59da0b2d69efe
Signed-off-by: Roger Ferraz <rogerio.ferraz@encora.com>
This commit is contained in:
Roger Ferraz 2023-07-13 12:58:50 -03:00
parent 901437c0fe
commit 5d501eedc7
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.rst
View File

@ -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