From 6ab8c4511d3fff5db3cc192f4de1e96397aafdb4 Mon Sep 17 00:00:00 2001 From: Radoslaw Smigielski Date: Mon, 7 Jan 2019 07:23:45 +0100 Subject: [PATCH] Sphinx throws warnings on workbooks descriptions Workbooks/workflow HTML docs are generated from descriptions and input params taken from workbooks .yaml. Two of the descriptions caused Sphinx to throw warnings. Change-Id: I1b8842f0bfbcdc011b23489b85a8a22e482a4f88 Partial-Bug: 1810707 --- workbooks/messaging.yaml | 6 +++--- workbooks/swift.yaml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/workbooks/messaging.yaml b/workbooks/messaging.yaml index e9bb82a83..727b8c179 100644 --- a/workbooks/messaging.yaml +++ b/workbooks/messaging.yaml @@ -17,15 +17,15 @@ workflows: calling workflow. If plan_name is provided the message will be persisted to Swift. In a - container named "{plan_name}-messages". The swift objects will be - named: + container named "{plan_name}-messages". The swift objects will be named: + {TYPE}/{TIMESTAMP}.yaml If a deployment_status is provided, the top-level deployment_status.yaml will also be updated, which will contain the deployment_status and the related message. - The standard message format will be: + The standard message format will be:: body: { type: 'tripleo.workflow.name', # Matches the workflow name diff --git a/workbooks/swift.yaml b/workbooks/swift.yaml index 4a48ab239..53735a3e1 100644 --- a/workbooks/swift.yaml +++ b/workbooks/swift.yaml @@ -50,7 +50,7 @@ workflows: object_exists: - description: >- + description: > Verify if a Swift object exists Given the name of a Swift container and object this workflow will