openstack/fuel-docs
Code Issues Proposed changes

Merge "Adds RST file with links to other sources for Fuel Plugin Guide"

Browse Source
This commit is contained in:
Jenkins 2015-04-24 14:17:48 +00:00 committed by Gerrit Code Review
commit 2369589a50
7 changed files with 93 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
contents.rst
View File

@ -14,6 +14,7 @@ Documentation
virtualbox
reference-architecture
terminology
plugin-dev
file-ref
release-notes
style-guide

1
contents/contents-plugin-dev.rst Normal file
View File

@ -0,0 +1 @@
.. include:: /pages/plugin-dev/links.rst

5
index.rst
View File

@ -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) <pdf/Mirantis-OpenStack-6.0-FuelPluginGuide.pdf>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Provides information on Fuel Plugins.
:ref:`terminology-ref` `(pdf) <pdf/Mirantis-OpenStack-6.0-Terminology-Reference.pdf>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

43
pages/plugin-dev/links.rst Normal file
View File

@ -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 <http://wiki.openstack.org/Fuel/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 <http://docs.mirantis.com/openstack/fuel/master/user-guide.html#install-fuel-plugins>`_ section from User Guide.
* `CLI command reference <http://docs.mirantis.com/openstack/fuel/master/user-guide.html#install-fuel-plugins>`_ 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 <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.

1
pdf/conf.py
View File

@ -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}),

31
pdf/pdf_plugin-dev.rst Normal file
View File

@ -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

11
plugin-dev.rst Normal file
View File

@ -0,0 +1,11 @@
.. index:: Fuel Plugin Guide
.. _plugin-dev:
=================
Fuel Plugin Guide
=================
.. contents:: :local:
.. include:: /contents/contents-plugin-dev.rst