starlingx
/
fault
Code Issues Proposed changes

Link alarms to current documentation URL 

Since the alarm documentation has been automated and the events.yaml
file is taken as source of truth for it, it is required to link
the alarms proposed repair action with a direct link to the
documentation for the users.

This change modifies the mentions of documentation to a proper link,
using Sphinx placeholder that are interpreted by the documentation
language.

Test plan
PASS:
* Build fm-doc package. Check that all parsing checks were run and
package was built successfully.

Closes-bug: 2022104

Change-Id: Iccb34e42ed80634d73cf7549e9230976579deef7
Signed-off-by: Agustin Carranza <agustin.carranza@windriver.com>
This commit is contained in:
Agustin Carranza 2023-06-15 16:04:12 -03:00
parent e2b15b733d
commit de22b91ed5
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
fm-doc/fm_doc/events.yaml
View File

@ -199,7 +199,7 @@
Entity_Instance_ID: fs_name=<image-conversion>
Severity: critical
Proposed_Repair_Action: "Add image-conversion filesystem on both controllers.
Consult the documentation for more details.
See the |prod-long| documentation at |docs-url| for more details.
If problem persists, contact next level of support."
Maintenance_Action: degrade
Inhibit_Alarms:
@ -3328,7 +3328,7 @@
'system storage-backend-delete <storage-backend-name>'
AND
'system storage-backend-add <storage-backend-name>'
Consult the documentation for more details.
See the |prod-long| documentation at |docs-url| for more details.
If problem persists, contact next level of support."
Maintenance_Action:
Inhibit_Alarms: