docs/templates/alarms_template.rst
Ron Stone 0478e2406c Add alarm severity legend
Generically describe alarm severities and requirements at top
of each alarm series.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id90d147ad4a3f4833c4d224761674ab66ef9f842
2022-11-29 10:09:15 -05:00

43 lines
707 B
ReStructuredText

head_format="
.. _<series-number>-series-alarm-messages-<Context>:
<over_score>
<series_number> Series Alarm Messages
<under_score>
.. include:: /shared/_includes/alarm-severities.rest
"
record_format="
.. list-table::
:widths: 6 25
:header-rows: 0
* - **Alarm ID: <alarm_id>**
- <Description>
* - Entity Instance
- <Entity_Instance_ID>
* - Degrade Affecting Severity:
- <Degrade_Affecting_Severity>
* - Severity:
- <Severity>
* - Proposed Repair Action
- <Proposed_Repair_Action>
* - Management Affecting Severity
- <Management_Affecting_Severity>
-----
"
foot_format="
.. raw:: html
&#8202;
"