openstack/fuel-docs
Code Issues Proposed changes

Merge "[Fuel Plugins] The terminology for Validation edit" into stable/6.1

Browse Source
This commit is contained in:
Jenkins
2015-08-10 12:22:15 +00:00
committed by Gerrit Code Review
parent 9d665c4671 e8cf55bf63
commit 17ddbaa52b
4 changed files with 54 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
pages/plugin-dev/links.rst
View File

@@ -39,8 +39,8 @@ Every plugin has its own prerequisites, limitations and use cases.
To learn about specific instructions and recommendations, enter
`Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.
Certification
-------------
Validation
----------
To learn about Mirantis Certification, see
`Fuel Plugin Certification <https://www.mirantis.com/partners/become-mirantis-technology-partner/fuel-plugin-development/fuel-plugin-certification/>`_ page.
To learn about Mirantis Validation, see
`Fuel Plugin Validation <https://www.mirantis.com/partners/become-mirantis-technology-partner/fuel-plugin-development/fuel-plugin-certification/>`_ page.

62
pages/style-guide/0901-style-notes-fuel-plugins.rst
View File

@@ -4,13 +4,13 @@ Creating documentation for Fuel Plugins
=======================================
Beginning with Fuel 6.0 release, you can create your own plugin
and certify it.
For certification procedure, you need to provide Mirantis
and validate it.
For the validation procedure, you need to provide Mirantis
with the required package of documentation and the plugin itself.
As to the documentation, it is divided into two blocks:
* Provided for certification procedure and created in pdf:
* Provided for the validation procedure and created in pdf:
#. Plugin Guide
@@ -200,37 +200,37 @@ Checklist
+++++++++
Please, before sending out the document
for certification,
for validation,
use this checklist to verify that it
meets all necessary requirements:
+-----------------------------------------------------+-------------------+
|Issue | Tick if done |
+=====================================================+===================+
| Plugin version is the same as the one | |
| defined in plugin's *metadata.yaml* file. | |
+-----------------------------------------------------+-------------------+
| Plugin's name stays the same and does not | |
| change within the document. | |
+-----------------------------------------------------+-------------------+
| All external links are clickable and | |
| lead to the existing pages with actual content. | |
+-----------------------------------------------------+-------------------+
| All screenshots are properly cropped, have high | |
| quality and provide the required information. The | |
| plugin-related UI elements are explained. | |
+-----------------------------------------------------+-------------------+
| All terms and complex concepts are put into | |
| *Key terms, acronyms and abbreviations* table, | |
| even if it goes about IP or UI. | |
+-----------------------------------------------------+-------------------+
| All commands have correct syntax and can be copied | |
| right into the console from the document. | |
+-----------------------------------------------------+-------------------+
| All steps have right order and the numbered lists | |
| are not mixed up. All lists have the same style | |
| that does not change within the document. | |
+-----------------------------------------------------+-------------------+
+-----------------------------------------------------+-------------------+
|Issue | Tick if done |
+=====================================================+===================+
| Plugin version is the same as the one | |
| defined in plugin's *metadata.yaml* file. | |
+-----------------------------------------------------+-------------------+
| Plugin's name stays the same and does not | |
| change within the document. | |
+-----------------------------------------------------+-------------------+
| All external links are clickable and | |
| lead to the existing pages with actual content. | |
+-----------------------------------------------------+-------------------+
| All screenshots are properly cropped, have high | |
| quality and provide the required information. The | |
| plugin-related UI elements are explained. | |
+-----------------------------------------------------+-------------------+
| All terms and complex concepts are put into | |
| *Key terms, acronyms and abbreviations* table, | |
| even if it goes about IP or UI. | |
+-----------------------------------------------------+-------------------+
| All commands have correct syntax and can be copied | |
| right into the console from the document. | |
+-----------------------------------------------------+-------------------+
| All steps have right order and the numbered lists | |
| are not mixed up. All lists have the same style | |
| that does not change within the document. | |
+-----------------------------------------------------+-------------------+

16
pages/terminology/p/plug-in-term.rst
View File

@@ -6,7 +6,7 @@ Plugin
Beginning with Mirantis OpenStack 6.0,
Fuel features the ability to install plugins before you deploy your environment.
Plugins are downloadable software components that extend the functionality of your
environments in a flexible, repeatable and reliable manner.
environments in a flexible, repeatable, and reliable manner.
For example,
`Neutron LBaaS <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/#lbaas>`_
@@ -24,19 +24,19 @@ you own plugin for Fuel, enter
`Fuel Plugins SDK <https://wiki.openstack.org/wiki/Fuel/Plugins>`_.
Note, that Mirantis provides
Fuel Plugins Certification -
Fuel Plugins Validation -
a set of technical and business
processes that Mirantis uses
to verify Fuel plugins built by vendors,
allowing customer choice of plugins to lead to a predictable outcome.
That means, Mirantis Certification ensures the quality of developed solution.
That means, Mirantis Validation ensures the quality of developed solution.
In terms of Certification, Fuel plugins fall into two categories:
In terms of Validation, Fuel plugins fall into two categories:
* *Certified* - thoroughly reviewed, tested and supported by Mirantis.
* *Validated* - thoroughly reviewed, tested and supported by Mirantis.
* *Non-Certified* - reviewed, tested in terms of code and installation procedure,
* *Non-Validated* - reviewed, tested in terms of code and installation procedure,
but not supported by Mirantis.
See the certification requirements at
`Fuel Plugin Certification <https://www.mirantis.com/partners/become-mirantis-technology-partner/fuel-plugin-development/fuel-plugin-certification/>`_ page.
See the validation requirements at
`Fuel Plugin Validation <https://www.mirantis.com/partners/become-mirantis-technology-partner/fuel-plugin-development/fuel-plugin-certification/>`_ page.

25
pages/user-guide/fuel-plugins/010-install-plugin.rst
View File

@@ -17,29 +17,26 @@ For example,
`Neutron LBaaS <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/#lbaas>`_
provides Load-Balancing-as-a-Service for Neutron, OpenStack Network Service.
Certification
-------------
Validation
----------
The Fuel Plugins Certification is
a set of technical and business
processes that Mirantis uses
to verify Fuel plugins built by vendors,
allowing customer choice of plugins to lead to a predictable outcome.
That means, Mirantis Certification ensures the quality of developed solution.
The Fuel Plugins Validation is a set of technical and business
processes that Mirantis uses to verify Fuel plugins built by vendors,
allowing a customer's choice of plugins to lead to a predictable outcome.
That means, Mirantis Validation ensures the quality of developed solution.
In terms of Certification, Fuel plugins fall into two categories:
In terms of Validation, Fuel plugins fall into two categories:
* *Certified* - thoroughly reviewed, tested and supported by Mirantis.
* *Validated* - thoroughly reviewed, tested and supported by Mirantis.
* *Non-Certified* - reviewed, tested in terms of code and installation procedure,
* *Non-Validated* - reviewed, tested in terms of code and installation procedure,
but not supported by Mirantis.
See the certification requirements at
See the validation requirements at
`Mirantis website <https://www.mirantis.com/partners/become-mirantis-technology-partner/fuel-plugin-development/fuel-plugin-certification/>`_.
For information on development requirements
and FAQ, see
For information on development requirements and FAQ, see
`Fuel Plugins <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ wiki page.