[Docs] Restructuring
Minor edits Change-Id: I7fa078272b0469301308b2dfbce48a29df5e8d92 Closes-Bug: #1603950
This commit is contained in:
parent
0c6524ecfc
commit
61f0e515ff
@ -1,11 +1,12 @@
|
|||||||
.. _developer-guide:
|
.. _developer-guide:
|
||||||
|
|
||||||
Developer guide
|
Application Developer Guide
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
step-by-step/step_by_step
|
||||||
exec_plan
|
exec_plan
|
||||||
hot_packages
|
hot_packages
|
||||||
murano_pl
|
murano_pl
|
@ -84,11 +84,11 @@ Application package could be composed manually. Follow the 5 steps below.
|
|||||||
|
|
||||||
`Browse` page looks like:
|
`Browse` page looks like:
|
||||||
|
|
||||||
.. image:: ../figures/chef_server.png
|
.. image:: figures/chef_server.png
|
||||||
|
|
||||||
The configuration form, where you can enter template parameters, will be generated automatically and looks as follows:
|
The configuration form, where you can enter template parameters, will be generated automatically and looks as follows:
|
||||||
|
|
||||||
.. image:: ../figures/chef_server_form.png
|
.. image:: figures/chef_server_form.png
|
||||||
|
|
||||||
After filling the form the application is ready to be deployed.
|
After filling the form the application is ready to be deployed.
|
||||||
|
|
@ -38,4 +38,4 @@ The application package root folder should contain the following:
|
|||||||
Here is the visual representation of the Murano application
|
Here is the visual representation of the Murano application
|
||||||
package structure:
|
package structure:
|
||||||
|
|
||||||
.. image:: ../../figures/structure.png
|
.. image:: ../figures/structure.png
|
@ -9,46 +9,3 @@ Appendix
|
|||||||
rest_api_spec
|
rest_api_spec
|
||||||
cli_ref
|
cli_ref
|
||||||
glossary
|
glossary
|
||||||
|
|
||||||
Miscellaneous
|
|
||||||
~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
**Background Concepts for Murano**
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
articles/workflow
|
|
||||||
|
|
||||||
|
|
||||||
**Tutorials**
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
image_builders/index
|
|
||||||
articles/test_docs
|
|
||||||
|
|
||||||
|
|
||||||
**Guidelines**
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
contributing
|
|
||||||
guidelines
|
|
||||||
|
|
||||||
**Gerrit review dashboard**
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
murano_gerrit_dashboard
|
|
||||||
|
|
||||||
|
|
||||||
**API specification**
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specification/index
|
|
42
doc/source/appendix/articles/articles_index.rst
Normal file
42
doc/source/appendix/articles/articles_index.rst
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
Miscellaneous
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
**Background Concepts for Murano**
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
workflow
|
||||||
|
|
||||||
|
|
||||||
|
**Tutorials**
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
image_builders/index
|
||||||
|
test_docs
|
||||||
|
|
||||||
|
|
||||||
|
**Guidelines**
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
contributing
|
||||||
|
guidelines
|
||||||
|
|
||||||
|
**Gerrit review dashboard**
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
murano_gerrit_dashboard
|
||||||
|
|
||||||
|
|
||||||
|
**API specification**
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specification/index
|
1
doc/source/appendix/articles/contributing.rst
Normal file
1
doc/source/appendix/articles/contributing.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
.. include:: ../../../../CONTRIBUTING.rst
|
11
doc/source/appendix/articles/specification/index.rst
Normal file
11
doc/source/appendix/articles/specification/index.rst
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
===========================
|
||||||
|
Murano API v1 specification
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
overview
|
||||||
|
murano-api
|
||||||
|
murano-repository
|
||||||
|
murano-env-temp
|
@ -1,7 +1,3 @@
|
|||||||
===========================
|
|
||||||
Murano API v1 specification
|
|
||||||
===========================
|
|
||||||
|
|
||||||
General information
|
General information
|
||||||
===================
|
===================
|
||||||
|
|
||||||
@ -43,8 +39,3 @@ General information
|
|||||||
All requests include a keystone authentication token header
|
All requests include a keystone authentication token header
|
||||||
(X-Auth-Token). Clients must authenticate with keystone before
|
(X-Auth-Token). Clients must authenticate with keystone before
|
||||||
interacting with the murano service.
|
interacting with the murano service.
|
||||||
|
|
||||||
.. include:: murano-api.rst
|
|
||||||
.. include:: murano-repository.rst
|
|
||||||
.. include:: murano-env-temp.rst
|
|
||||||
|
|
@ -1 +0,0 @@
|
|||||||
.. include:: ../../../CONTRIBUTING.rst
|
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
.. _contributor-guide:
|
.. _contributor-guide:
|
||||||
|
|
||||||
Contributor guide
|
Contributor Guide
|
||||||
~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
.. _quickstart:
|
.. _quickstart:
|
||||||
|
|
||||||
==========
|
==========
|
||||||
Quickstart
|
QuickStart
|
||||||
==========
|
==========
|
||||||
|
|
||||||
This is a brief walkthrough to quickly get you familiar with the basic
|
This is a brief walkthrough to quickly get you familiar with the basic
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
.. _user-guide:
|
.. _user-guide:
|
||||||
|
|
||||||
User guide
|
User Guide
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
@ -62,8 +62,8 @@ client.
|
|||||||
|
|
||||||
administrator-guide/admin_index
|
administrator-guide/admin_index
|
||||||
|
|
||||||
Developer Documentation
|
Application Developer Documentation
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Learn how to compose an application package and get it ready for uploading to
|
Learn how to compose an application package and get it ready for uploading to
|
||||||
Murano.
|
Murano.
|
||||||
@ -71,8 +71,7 @@ Murano.
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
appdev-guide/step-by-step/step_by_step
|
appdev-guide/developer_index
|
||||||
appdev-guide/developerguide/developer_index
|
|
||||||
appdev-guide/faq
|
appdev-guide/faq
|
||||||
|
|
||||||
Contributor Documentation
|
Contributor Documentation
|
||||||
@ -92,3 +91,4 @@ Other Documentation
|
|||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
appendix/appendix_index
|
appendix/appendix_index
|
||||||
|
appendix/articles/articles_index
|
Loading…
x
Reference in New Issue
Block a user