openstack/tripleo-common
Code Issues Proposed changes

Sphinx throws warnings on workbooks descriptions

Browse Source 
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
This commit is contained in:
Radoslaw Smigielski 2019-01-07 07:23:45 +01:00
parent b6f739b722
commit 6ab8c4511d
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
workbooks/messaging.yaml
View File

@ -17,15 +17,15 @@ workflows:
calling workflow. calling workflow.
If plan_name is provided the message will be persisted to Swift. In a If plan_name is provided the message will be persisted to Swift. In a
container named "{plan_name}-messages". The swift objects will be container named "{plan_name}-messages". The swift objects will be named:
named:
{TYPE}/{TIMESTAMP}.yaml {TYPE}/{TIMESTAMP}.yaml
If a deployment_status is provided, the top-level deployment_status.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 will also be updated, which will contain the deployment_status and the
related message. related message.
The standard message format will be: The standard message format will be::
body: { body: {
type: 'tripleo.workflow.name', # Matches the workflow name type: 'tripleo.workflow.name', # Matches the workflow name

2
workbooks/swift.yaml
View File

@ -50,7 +50,7 @@ workflows:
object_exists: object_exists:
description: >- description: >
Verify if a Swift object exists Verify if a Swift object exists
Given the name of a Swift container and object this workflow will Given the name of a Swift container and object this workflow will