From 40b55a7aadad198567fe7d4222d76295d11befa4 Mon Sep 17 00:00:00 2001 From: Yushiro FURUKAWA Date: Thu, 29 Sep 2016 17:20:57 +0900 Subject: [PATCH] Revises json to JSON, yaml to YAML and yaql to YAQL in documents Change-Id: I7a097c7d68c24726711e1d332e33cb134fba1d00 --- .../appdev-guide/app_migrating/app_migrate_to_liberty.rst | 2 +- doc/source/appdev-guide/app_unit_tests.rst | 4 ++-- doc/source/appdev-guide/murano_bundles.rst | 2 +- doc/source/appdev-guide/murano_pl/statics.rst | 2 +- doc/source/appdev-guide/muranopackages/dynamic_ui.rst | 6 +++--- .../appdev-guide/muranopackages/package_structure.rst | 2 +- doc/source/appdev-guide/muranopackages/repository.rst | 2 +- doc/source/draft/admin-guide/admin_troubleshooting.rst | 2 +- doc/source/specification/murano-repository.rst | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/source/appdev-guide/app_migrating/app_migrate_to_liberty.rst b/doc/source/appdev-guide/app_migrating/app_migrate_to_liberty.rst index b90233f2..adf9a6e0 100644 --- a/doc/source/appdev-guide/app_migrating/app_migrate_to_liberty.rst +++ b/doc/source/appdev-guide/app_migrating/app_migrate_to_liberty.rst @@ -100,7 +100,7 @@ package. ------- In Liberty, murano was updated to use `yaql 1.0.0`. -The new version of yaql allows you to use a number of new functions and +The new version of YAQL allows you to use a number of new functions and features that help to increase the speed of developing new applications. .. note:: diff --git a/doc/source/appdev-guide/app_unit_tests.rst b/doc/source/appdev-guide/app_unit_tests.rst index 82009ef5..b4682528 100644 --- a/doc/source/appdev-guide/app_unit_tests.rst +++ b/doc/source/appdev-guide/app_unit_tests.rst @@ -147,8 +147,8 @@ unit tests: Methods: initialize: Body: - # Object model can be loaded from json file, or provided - # directly in MuranoPL code as a yaml insertion. + # Object model can be loaded from JSON file, or provided + # directly in MuranoPL code as a YAML insertion. - $.appJson: new(sys:Resources).json('tomcat-for-mock.json') - $.heatOutput: new(sys:Resources).json('output.json') - $.log: logger('test') diff --git a/doc/source/appdev-guide/murano_bundles.rst b/doc/source/appdev-guide/murano_bundles.rst index f7808d1e..5988b563 100644 --- a/doc/source/appdev-guide/murano_bundles.rst +++ b/doc/source/appdev-guide/murano_bundles.rst @@ -18,7 +18,7 @@ Specific information about *bundle-import* command can be found at Bundle structure ~~~~~~~~~~~~~~~~ -Bundle description is a json structure, that contains list of packages +Bundle description is a JSON structure, that contains list of packages in the bundle and bundle version. Here is the example: .. code-block:: javascript diff --git a/doc/source/appdev-guide/murano_pl/statics.rst b/doc/source/appdev-guide/murano_pl/statics.rst index 0571b883..e0a03dfd 100644 --- a/doc/source/appdev-guide/murano_pl/statics.rst +++ b/doc/source/appdev-guide/murano_pl/statics.rst @@ -128,7 +128,7 @@ at least one argument. Extension methods can also be written in Python just the same way as static methods. However one should be careful in method declaration and use precise -yaql specification of the type of first method argument otherwise the method +YAQL specification of the type of first method argument otherwise the method will become an extension of any type. To turn Python static method into extension method it must be decorated with diff --git a/doc/source/appdev-guide/muranopackages/dynamic_ui.rst b/doc/source/appdev-guide/muranopackages/dynamic_ui.rst index fe684400..c1bdd237 100644 --- a/doc/source/appdev-guide/muranopackages/dynamic_ui.rst +++ b/doc/source/appdev-guide/muranopackages/dynamic_ui.rst @@ -88,8 +88,8 @@ Application and Templates ------------------------- The Application section describes an *application object model*. -This model will be translated into json, and an application will be -deployed according to that json. The application section should +This model will be translated into JSON, and an application will be +deployed according to that JSON. The application section should contain all necessary keys that are required by the murano-engine to deploy an application. Note that the system section of the object model goes under the *?*. So murano recognizes that instead of simple value, @@ -204,7 +204,7 @@ field attributes. The most common attributes are the following: * **label** - name, that will be displayed in the form; defaults to **name** being capitalized. * **description** - description, that will be displayed in the description area. - Use yaml line folding character ``>-`` to keep the correct formatting during + Use YAML line folding character ``>-`` to keep the correct formatting during data transferring. * **descriptionTitle** - title of the description, defaults to **label**; displayed in the description area diff --git a/doc/source/appdev-guide/muranopackages/package_structure.rst b/doc/source/appdev-guide/muranopackages/package_structure.rst index 8c5c4ee1..648431d9 100644 --- a/doc/source/appdev-guide/muranopackages/package_structure.rst +++ b/doc/source/appdev-guide/muranopackages/package_structure.rst @@ -22,7 +22,7 @@ The application package root folder should contain the following: deployment located in it. **UI** folder - contains the dynamic UI yaml definitions. + contains the dynamic UI YAML definitions. **logo.png** file (optional) is an image file associated to your application. diff --git a/doc/source/appdev-guide/muranopackages/repository.rst b/doc/source/appdev-guide/muranopackages/repository.rst index 3696bc26..0f514877 100644 --- a/doc/source/appdev-guide/muranopackages/repository.rst +++ b/doc/source/appdev-guide/muranopackages/repository.rst @@ -15,7 +15,7 @@ It is fairly easy to set up your own murano package repository. To do so you nee When importing an application by name, the client appends any version info, if present to the application name, ``.zip`` file extension and searches for that file in the ``apps`` directory. -When importing a bundle by name, the client appends ``.bundle`` file extension to the bundle name and searches it in the bundles directory. A bundle file is a json or a yaml file with the following structure: +When importing a bundle by name, the client appends ``.bundle`` file extension to the bundle name and searches it in the bundles directory. A bundle file is a JSON or a YAML file with the following structure: .. code-block:: json diff --git a/doc/source/draft/admin-guide/admin_troubleshooting.rst b/doc/source/draft/admin-guide/admin_troubleshooting.rst index e72cbc62..f9025fcd 100644 --- a/doc/source/draft/admin-guide/admin_troubleshooting.rst +++ b/doc/source/draft/admin-guide/admin_troubleshooting.rst @@ -87,7 +87,7 @@ that failed would have red color. **while scanning a simple key in "", line 32, column 3: ...** There is an error in YAML file format. -Before uploading a package, validate your file in an online yaml validator +Before uploading a package, validate your file in an online YAML validator like `YAMLint `_. Later `validation tool `_ to check package closely while uploading will be added. diff --git a/doc/source/specification/murano-repository.rst b/doc/source/specification/murano-repository.rst index 3b813ffc..043a3c36 100644 --- a/doc/source/specification/murano-repository.rst +++ b/doc/source/specification/murano-repository.rst @@ -131,7 +131,7 @@ Upload a new package[POST] `/v1/catalog/packages` -See the example of multipart/form-data request, It should contain two parts - text (json string) and file object +See the example of multipart/form-data request, It should contain two parts - text (JSON string) and file object **Request (multipart/form-data)**