summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2017-12-09 03:33:57 +0000
committerGerrit Code Review <review@openstack.org>2017-12-09 03:33:57 +0000
commit2eda92aaf40bf564b5ce335d8dbf413405471cbd (patch)
tree0bc01d6dce009e255915544bfc5bd41c8ff8deac
parent128da625b060ef5e631dc3be07b9d435fac365d1 (diff)
parenta024fa6936cf07b55b75384cb978162e1f706e45 (diff)
Merge "Document error"HEADmaster
-rw-r--r--doc/source/admin/appdev-guide/step-by-step/part1.rst7
-rw-r--r--doc/source/admin/appdev-guide/step-by-step/part2.rst7
2 files changed, 10 insertions, 4 deletions
diff --git a/doc/source/admin/appdev-guide/step-by-step/part1.rst b/doc/source/admin/appdev-guide/step-by-step/part1.rst
index dd8b3a9..39301a1 100644
--- a/doc/source/admin/appdev-guide/step-by-step/part1.rst
+++ b/doc/source/admin/appdev-guide/step-by-step/part1.rst
@@ -56,6 +56,8 @@ domain-specific prefix.
56Murano, while a ``Library`` is bundle of reusable scenarios which may be used 56Murano, while a ``Library`` is bundle of reusable scenarios which may be used
57by other packages. For now we just need a single standalone app, so let's 57by other packages. For now we just need a single standalone app, so let's
58choose an ``Application`` type. 58choose an ``Application`` type.
59The ``Description`` is a text attribute, providing detailed info about your
60package.
59 61
60Enter these values and save the file. You should have something like this: 62Enter these values and save the file. You should have something like this:
61 63
@@ -64,7 +66,10 @@ Enter these values and save the file. You should have something like this:
64 66
65 FullName: com.yourdomain.HelloWorld 67 FullName: com.yourdomain.HelloWorld
66 Type: Application 68 Type: Application
67 69 Description: |
70 A package which demonstrates
71 development for Murano
72 by greeting the user.
68 73
69This is the minimum required to start. We'll add more manifest data later. 74This is the minimum required to start. We'll add more manifest data later.
70 75
diff --git a/doc/source/admin/appdev-guide/step-by-step/part2.rst b/doc/source/admin/appdev-guide/step-by-step/part2.rst
index 5af0c4b..346c2bc 100644
--- a/doc/source/admin/appdev-guide/step-by-step/part2.rst
+++ b/doc/source/admin/appdev-guide/step-by-step/part2.rst
@@ -392,6 +392,10 @@ part contained only mandatory fields. This is how it should look by now:
392 392
393 FullName: com.yourdomain.HelloWorld 393 FullName: com.yourdomain.HelloWorld
394 Type: Application 394 Type: Application
395 Description: |
396 A package which demonstrates
397 development for Murano
398 by greeting the user.
395 Classes: 399 Classes:
396 com.yourdomain.HelloWorld: HelloWorld.yaml 400 com.yourdomain.HelloWorld: HelloWorld.yaml
397 401
@@ -401,9 +405,6 @@ First, you can add a ``Name`` attribute. Unlike ``FullName``, it is not a
401unique identifier of the package. But, if specified, it overrides the name of 405unique identifier of the package. But, if specified, it overrides the name of
402the package that is displayed in the catalog. 406the package that is displayed in the catalog.
403 407
404Then there is a ``Description`` field. This is a multi-line text attribute,
405providing detailed info about your package.
406
407Then an ``Author`` field: here you can put your name or the name of your 408Then an ``Author`` field: here you can put your name or the name of your
408company, so it will be displayed in catalog as the name of the package 409company, so it will be displayed in catalog as the name of the package
409developer. If this field is omitted, the catalog will consider the package to 410developer. If this field is omitted, the catalog will consider the package to