diff --git a/contents.rst b/contents.rst index 201bd00a1..b2f1efd01 100644 --- a/contents.rst +++ b/contents.rst @@ -14,6 +14,7 @@ Documentation virtualbox reference-architecture terminology + plugin-dev file-ref release-notes style-guide diff --git a/contents/contents-plugin-dev.rst b/contents/contents-plugin-dev.rst new file mode 100644 index 000000000..5f788202c --- /dev/null +++ b/contents/contents-plugin-dev.rst @@ -0,0 +1 @@ +.. include:: /pages/plugin-dev/links.rst \ No newline at end of file diff --git a/index.rst b/index.rst index 9caa12633..f8750d3e0 100644 --- a/index.rst +++ b/index.rst @@ -64,6 +64,11 @@ for demonstration and evaluation purposes. A deep dive into the structure of the Mirantis OpenStack environment, network considerations, and deployment options. +:ref:`plugin-dev` `(pdf) `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Provides information on Fuel Plugins. + :ref:`terminology-ref` `(pdf) `__ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/pages/plugin-dev/links.rst b/pages/plugin-dev/links.rst new file mode 100644 index 000000000..3cb4422b1 --- /dev/null +++ b/pages/plugin-dev/links.rst @@ -0,0 +1,43 @@ +.. _links: + +Fuel Plugin Guide +================= + +Fuel Plugin Guide is now split into separate sources of information +according to the issues covered: + +Development +----------- + +`Plugins `_ wiki page. +It covers the following issues: + +* entry development requirements + +* CI + +* repo + +* testing + +* documentation + +* reporting bugs. + + +Installation instructions +------------------------- + +Common installation instructions: + +* `Install Fuel Plugins `_ section from User Guide. + +* `CLI command reference `_ section from User Guide. + +Plugin-specific instructions +---------------------------- + +Every plugin has its own prerequisites, limitations and use cases. +To learn about specific instructions and recommendations, enter +`Fuel Plugins Catalog `_. + diff --git a/pdf/conf.py b/pdf/conf.py index c5443a3ad..8bd118b82 100644 --- a/pdf/conf.py +++ b/pdf/conf.py @@ -23,6 +23,7 @@ pdf_documents = [ ('pdf/pdf_operations', u'Mirantis-OpenStack-6.0-OperationsGuide', u'Operations Guide', u'2014, Mirantis Inc.'), ('pdf/pdf_virtualbox', u'Mirantis-OpenStack-6.0-Running-Mirantis-OpenStack-on-VirtualBox', u'Running Mirantis OpenStack on VirtualBox', u'2014, Mirantis Inc.'), ('pdf/pdf_reference', u'Mirantis-OpenStack-6.0-ReferenceArchitecture', u'Reference Architecture', u'2014, Mirantis Inc.'), + ('pdf/pdf_plugin-dev', u'Mirantis-OpenStack-6.0-FuelPluginGuide', u'Fuel Plugin Guide', u'2014, Mirantis Inc.'), ('pdf/pdf_terminology', u'Mirantis-OpenStack-6.0-Terminology-Reference', u'Terminology Reference', u'2014, Mirantis Inc.'), ('pdf/pdf_file-ref', u'Mirantis-OpenStack-6.0-File-Format-Reference', u'File Format Reference', u'2014, Mirantis Inc.'), ('pdf/pdf_relnotes', u'Mirantis-OpenStack-6.0-RelNotes', u'Release Notes', u'2014, Mirantis Inc.', {'pdf_use_toc': False}), diff --git a/pdf/pdf_plugin-dev.rst b/pdf/pdf_plugin-dev.rst new file mode 100644 index 000000000..4a5e593e4 --- /dev/null +++ b/pdf/pdf_plugin-dev.rst @@ -0,0 +1,31 @@ +.. header:: + + .. cssclass:: header-table + + +-------------------------------------+-----------------------------------+ + | Mirantis OpenStack v6.1 | .. cssclass:: right| + | | | + | Fuel Plugin Guide | ###Section### | + +-------------------------------------+-----------------------------------+ + +.. footer:: + + .. cssclass:: footer-table + + +--------------------------+----------------------+ + | | .. cssclass:: right| + | | | + | ©2015, Mirantis Inc. | Page ###Page### | + +--------------------------+----------------------+ + +.. raw:: pdf + + PageBreak oneColumn + +.. toctree:: + +.. include:: /pages/preface/preface.rst + +.. _operations-guide: + +.. include:: /contents/contents-plugin-dev.rst diff --git a/plugin-dev.rst b/plugin-dev.rst new file mode 100644 index 000000000..89f81a60e --- /dev/null +++ b/plugin-dev.rst @@ -0,0 +1,11 @@ +.. index:: Fuel Plugin Guide + +.. _plugin-dev: + +================= +Fuel Plugin Guide +================= + +.. contents:: :local: + +.. include:: /contents/contents-plugin-dev.rst