diff options
-rw-r--r-- | .gitignore | 5 | ||||
-rw-r--r-- | Makefile | 44 | ||||
-rw-r--r-- | docs/design/index.rst (renamed from design_docs/README) | 11 | ||||
-rw-r--r-- | docs/design/notification-alarm-evaluator.rst (renamed from design_docs/notification-alarm-evaluator.rst) | 0 | ||||
-rw-r--r-- | docs/design/report-host-fault-to-update-server-state-immediately.rst (renamed from design_docs/report-host-fault-to-update-server-state-immediately.rst) | 0 | ||||
-rw-r--r-- | docs/etc/conf.py | 34 | ||||
-rw-r--r-- | docs/etc/opnfv-logo.png | bin | 2829 -> 0 bytes | |||
-rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 86 | ||||
-rw-r--r-- | docs/how-to-use-docs/index.rst | 30 | ||||
-rw-r--r-- | docs/manuals/index.rst | 9 | ||||
-rw-r--r-- | docs/manuals/mark-host-down_manual.rst (renamed from manuals/mark-host-down_manual.rst) | 10 | ||||
-rw-r--r-- | docs/requirements/01-intro.rst (renamed from requirements/01-intro.rst) | 0 | ||||
-rw-r--r-- | docs/requirements/02-use_cases.rst (renamed from requirements/02-use_cases.rst) | 0 | ||||
-rw-r--r-- | docs/requirements/03-architecture.rst (renamed from requirements/03-architecture.rst) | 0 | ||||
-rw-r--r-- | docs/requirements/04-gaps.rst (renamed from requirements/04-gaps.rst) | 0 | ||||
-rw-r--r-- | docs/requirements/05-implementation.rst (renamed from requirements/05-implementation.rst) | 0 | ||||
-rw-r--r-- | docs/requirements/06-summary.rst (renamed from requirements/06-summary.rst) | 0 | ||||
-rw-r--r-- | docs/requirements/07-annex.rst (renamed from requirements/07-annex.rst) | 0 | ||||
-rw-r--r-- | docs/requirements/99-references.rst (renamed from requirements/99-references.rst) | 0 | ||||
-rw-r--r-- | docs/requirements/glossary.rst (renamed from requirements/glossary.rst) | 0 | ||||
-rwxr-xr-x | docs/requirements/images/figure1.png (renamed from requirements/images/figure1.png) | bin | 977880 -> 977880 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure10.png (renamed from requirements/images/figure10.png) | bin | 422212 -> 422212 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure11.png (renamed from requirements/images/figure11.png) | bin | 355225 -> 355225 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure12.png (renamed from requirements/images/figure12.png) | bin | 2144916 -> 2144916 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure13.png (renamed from requirements/images/figure13.png) | bin | 646427 -> 646427 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure14.png (renamed from requirements/images/figure14.png) | bin | 578986 -> 578986 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure2.png (renamed from requirements/images/figure2.png) | bin | 1043699 -> 1043699 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure3.png (renamed from requirements/images/figure3.png) | bin | 308234 -> 308234 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure4.png (renamed from requirements/images/figure4.png) | bin | 186805 -> 186805 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure5.png (renamed from requirements/images/figure5.png) | bin | 324967 -> 324967 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure6.png (renamed from requirements/images/figure6.png) | bin | 425612 -> 425612 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure7.png (renamed from requirements/images/figure7.png) | bin | 315053 -> 315053 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure8.png (renamed from requirements/images/figure8.png) | bin | 464430 -> 464430 bytes | |||
-rwxr-xr-x | docs/requirements/images/figure9.png (renamed from requirements/images/figure9.png) | bin | 459353 -> 459353 bytes | |||
-rw-r--r-- | docs/requirements/index.rst (renamed from requirements/index.rst) | 14 | ||||
-rw-r--r-- | etc/conf.py | 27 |
36 files changed, 33 insertions, 237 deletions
@@ -1,2 +1,3 @@ -build/ -public/ +/build/ +/output/ +/releng/ diff --git a/Makefile b/Makefile deleted file mode 100644 index 1e06ef3c..00000000 --- a/Makefile +++ /dev/null @@ -1,44 +0,0 @@ -BUILDDIR := build -PUBLICDIR := public -DESIGN_DOCS = $(wildcard design_docs/*.rst) -MANUALS = $(wildcard manuals/*.rst) - -.PHONY: clean html pdf bps man all public - -define index - rm -f $1/index.html - find $1 -type f | while read a; do echo "<li><a href=$${a#$1/}>$${a#$1/}</a></li>" >> $1/index.html; done -endef - -all: man bps html pdf - $(call index,$(BUILDDIR)) - -public: - rm -rf $(PUBLICDIR) - mkdir -p $(PUBLICDIR) - cp -r $(BUILDDIR)/manuals $(PUBLICDIR)/ - cp -r $(BUILDDIR)/design_docs $(PUBLICDIR)/ - cp -r $(BUILDDIR)/requirements/html $(PUBLICDIR)/ - cp -r $(BUILDDIR)/requirements/latex/*.pdf $(PUBLICDIR)/ - $(call index,$(PUBLICDIR)) - -clean: - rm -rf $(BUILDDIR)/* - -man: - mkdir -p $(BUILDDIR)/manuals - $(foreach f,$(MANUALS),rst2html.py $(f) $(BUILDDIR)/$(f:.rst=.html);) - -bps: $(DESIGN_DOCS) - mkdir -p $(BUILDDIR)/design_docs - $(foreach f,$(DESIGN_DOCS),rst2html.py $(f) $(BUILDDIR)/$(f:.rst=.html);) - -html: - sphinx-build -b html -c etc -d $(BUILDDIR)/doctrees \ - requirements $(BUILDDIR)/requirements/html - -pdf: - sphinx-build -b latex -c etc -d $(BUILDDIR)/doctrees \ - requirements $(BUILDDIR)/requirements/latex - $(MAKE) -C $(BUILDDIR)/requirements/latex \ - LATEXOPTS='--interaction=nonstopmode' all-pdf diff --git a/design_docs/README b/docs/design/index.rst index f0491cf6..981b7af1 100644 --- a/design_docs/README +++ b/docs/design/index.rst @@ -1,3 +1,7 @@ +**************** +Design Documents +**************** + This is the directory to store design documents which may include draft versions of blueprints written before proposing to upstream OSS communities such as OpenStack, in order to keep the original blueprint as reviewed in @@ -7,3 +11,10 @@ document to find the latest version of the blueprint and status of development in the relevant OSS community. See also https://wiki.opnfv.org/requirements_projects . + +.. toctree:: + :numbered: + :maxdepth: 4 + + report-host-fault-to-update-server-state-immediately.rst + notification-alarm-evaluator.rst diff --git a/design_docs/notification-alarm-evaluator.rst b/docs/design/notification-alarm-evaluator.rst index 750e39c0..750e39c0 100644 --- a/design_docs/notification-alarm-evaluator.rst +++ b/docs/design/notification-alarm-evaluator.rst diff --git a/design_docs/report-host-fault-to-update-server-state-immediately.rst b/docs/design/report-host-fault-to-update-server-state-immediately.rst index 0ee02064..0ee02064 100644 --- a/design_docs/report-host-fault-to-update-server-state-immediately.rst +++ b/docs/design/report-host-fault-to-update-server-state-immediately.rst diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index 00660351..00000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,34 +0,0 @@ -import datetime -import sys -import os - -try: - __import__('imp').find_module('sphinx.ext.numfig') - extensions = ['sphinx.ext.numfig'] -except ImportError: - # 'pip install sphinx_numfig' - extensions = ['sphinx_numfig'] - -# numfig: -number_figures = True -figure_caption_prefix = "Fig." - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'OPNFV: Template documentation config' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png Binary files differdeleted file mode 100644 index 1519503e..00000000 --- a/docs/etc/opnfv-logo.png +++ /dev/null diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst deleted file mode 100644 index afcf7581..00000000 --- a/docs/how-to-use-docs/documentation-example.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left -.. these two pipes are to seperate the logo from the first title -| -| -How to create documentation for your OPNFV project -================================================== - -this is the directory structure of the docs/ directory that can be found in the root of your project directory - -.. code-block:: bash - - ./etc - ./etc/opnfv-logo.png - ./etc/conf.py - ./how-to-use-docs - ./how-to-use-docs/documentation-example.rst - ./how-to-use-docs/index.rst - -To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst. -This index file must refence your other rst files. - -* Here is an example index.rst - -.. code-block:: bash - - Example Documentation table of contents - ======================================= - - Contents: - - .. toctree:: - :numbered: - :maxdepth: 4 - - documentation-example.rst - - Indices and tables - ================== - - * :ref:`search` - - Revision: _sha1_ - - Build date: |today| - - -The Sphinx Build -================ - -When you push documentation changes to gerrit a jenkins job will create html documentation. - -* Verify Jobs -For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result. - -* Merge jobs - -Once you are happy with the look of your documentation you can submit the patchset the merge job will -copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html - -Here are some quick examples of how to use rst markup - -This is a headline:: - - here is some code, note that it is indented - -links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/ - -* Bulleted Items - - **this will be bold** - -.. code-block:: bash - - echo "Heres is a code block with bash syntax highlighting" - - -Leave these at the bottom of each of your documents they are used internally - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst deleted file mode 100644 index 36710b32..00000000 --- a/docs/how-to-use-docs/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. OPNFV Release Engineering documentation, created by - sphinx-quickstart on Tue Jun 9 19:12:31 2015. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - -Example Documentation table of contents -======================================= - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 4 - - documentation-example.rst - -Indices and tables -================== - -* :ref:`search` - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/manuals/index.rst b/docs/manuals/index.rst new file mode 100644 index 00000000..b3e9e633 --- /dev/null +++ b/docs/manuals/index.rst @@ -0,0 +1,9 @@ +******* +Manuals +******* + +.. toctree:: + :numbered: + :maxdepth: 2 + + mark-host-down_manual.rst diff --git a/manuals/mark-host-down_manual.rst b/docs/manuals/mark-host-down_manual.rst index 499644f7..7962dba3 100644 --- a/manuals/mark-host-down_manual.rst +++ b/docs/manuals/mark-host-down_manual.rst @@ -1,11 +1,15 @@ +========================================= OpenStack NOVA API for marking host down. +========================================= Related Blueprints: +=================== https://blueprints.launchpad.net/nova/+spec/mark-host-down https://blueprints.launchpad.net/python-novaclient/+spec/support-force-down-service What the API is for +=================== This API will give external fault monitoring system a possibility of telling OpenStack Nova fast that compute host is down. This will immediately enable @@ -13,6 +17,7 @@ What the API is for actions. What this API does +================== In OpenStack the nova-compute service state can represent the compute host state and this new API is used to force this service down. It is assumed @@ -28,6 +33,7 @@ What this API does https://blueprints.launchpad.net/nova/+spec/robustify-evacuate REST API for forcing down: +========================== Parameter explanations: tenant_id: Identifier of the tenant. @@ -62,6 +68,7 @@ REST API for forcing down: inary": "nova-compute", "host": "compute1", "forced_down": true}' CLI for forcing down: +===================== nova service-force-down <hostname> nova-compute @@ -69,6 +76,7 @@ CLI for forcing down: nova service-force-down compute1 nova-compute REST API for disabling forced down: +=================================== Parameter explanations: tenant_id: Identifier of the tenant. @@ -103,6 +111,8 @@ REST API for disabling forced down: inary": "nova-compute", "host": "compute1", "forced_down": false}' CLI for disabling forced down: +============================== + nova service-force-down --unset <hostname> nova-compute Example: diff --git a/requirements/01-intro.rst b/docs/requirements/01-intro.rst index 2190fdf7..2190fdf7 100644 --- a/requirements/01-intro.rst +++ b/docs/requirements/01-intro.rst diff --git a/requirements/02-use_cases.rst b/docs/requirements/02-use_cases.rst index 775f0b77..775f0b77 100644 --- a/requirements/02-use_cases.rst +++ b/docs/requirements/02-use_cases.rst diff --git a/requirements/03-architecture.rst b/docs/requirements/03-architecture.rst index 9b618e01..9b618e01 100644 --- a/requirements/03-architecture.rst +++ b/docs/requirements/03-architecture.rst diff --git a/requirements/04-gaps.rst b/docs/requirements/04-gaps.rst index 67ef86c4..67ef86c4 100644 --- a/requirements/04-gaps.rst +++ b/docs/requirements/04-gaps.rst diff --git a/requirements/05-implementation.rst b/docs/requirements/05-implementation.rst index e7f35158..e7f35158 100644 --- a/requirements/05-implementation.rst +++ b/docs/requirements/05-implementation.rst diff --git a/requirements/06-summary.rst b/docs/requirements/06-summary.rst index 554c4d9f..554c4d9f 100644 --- a/requirements/06-summary.rst +++ b/docs/requirements/06-summary.rst diff --git a/requirements/07-annex.rst b/docs/requirements/07-annex.rst index dbe41bd1..dbe41bd1 100644 --- a/requirements/07-annex.rst +++ b/docs/requirements/07-annex.rst diff --git a/requirements/99-references.rst b/docs/requirements/99-references.rst index b0aaaff2..b0aaaff2 100644 --- a/requirements/99-references.rst +++ b/docs/requirements/99-references.rst diff --git a/requirements/glossary.rst b/docs/requirements/glossary.rst index 47f1450b..47f1450b 100644 --- a/requirements/glossary.rst +++ b/docs/requirements/glossary.rst diff --git a/requirements/images/figure1.png b/docs/requirements/images/figure1.png Binary files differindex dacf0dd4..dacf0dd4 100755 --- a/requirements/images/figure1.png +++ b/docs/requirements/images/figure1.png diff --git a/requirements/images/figure10.png b/docs/requirements/images/figure10.png Binary files differindex d3268018..d3268018 100755 --- a/requirements/images/figure10.png +++ b/docs/requirements/images/figure10.png diff --git a/requirements/images/figure11.png b/docs/requirements/images/figure11.png Binary files differindex b5fe0f8c..b5fe0f8c 100755 --- a/requirements/images/figure11.png +++ b/docs/requirements/images/figure11.png diff --git a/requirements/images/figure12.png b/docs/requirements/images/figure12.png Binary files differindex 2d394629..2d394629 100755 --- a/requirements/images/figure12.png +++ b/docs/requirements/images/figure12.png diff --git a/requirements/images/figure13.png b/docs/requirements/images/figure13.png Binary files differindex 5f8227a5..5f8227a5 100755 --- a/requirements/images/figure13.png +++ b/docs/requirements/images/figure13.png diff --git a/requirements/images/figure14.png b/docs/requirements/images/figure14.png Binary files differindex b65ca9ae..b65ca9ae 100755 --- a/requirements/images/figure14.png +++ b/docs/requirements/images/figure14.png diff --git a/requirements/images/figure2.png b/docs/requirements/images/figure2.png Binary files differindex 3c8a2bf1..3c8a2bf1 100755 --- a/requirements/images/figure2.png +++ b/docs/requirements/images/figure2.png diff --git a/requirements/images/figure3.png b/docs/requirements/images/figure3.png Binary files differindex ee04dfae..ee04dfae 100755 --- a/requirements/images/figure3.png +++ b/docs/requirements/images/figure3.png diff --git a/requirements/images/figure4.png b/docs/requirements/images/figure4.png Binary files differindex 9eff177a..9eff177a 100755 --- a/requirements/images/figure4.png +++ b/docs/requirements/images/figure4.png diff --git a/requirements/images/figure5.png b/docs/requirements/images/figure5.png Binary files differindex fc38c57b..fc38c57b 100755 --- a/requirements/images/figure5.png +++ b/docs/requirements/images/figure5.png diff --git a/requirements/images/figure6.png b/docs/requirements/images/figure6.png Binary files differindex cf0d2be9..cf0d2be9 100755 --- a/requirements/images/figure6.png +++ b/docs/requirements/images/figure6.png diff --git a/requirements/images/figure7.png b/docs/requirements/images/figure7.png Binary files differindex b88a2e65..b88a2e65 100755 --- a/requirements/images/figure7.png +++ b/docs/requirements/images/figure7.png diff --git a/requirements/images/figure8.png b/docs/requirements/images/figure8.png Binary files differindex 907a0b30..907a0b30 100755 --- a/requirements/images/figure8.png +++ b/docs/requirements/images/figure8.png diff --git a/requirements/images/figure9.png b/docs/requirements/images/figure9.png Binary files differindex 61501c4d..61501c4d 100755 --- a/requirements/images/figure9.png +++ b/docs/requirements/images/figure9.png diff --git a/requirements/index.rst b/docs/requirements/index.rst index 61046c3f..ae5f2a34 100644 --- a/requirements/index.rst +++ b/docs/requirements/index.rst @@ -1,12 +1,3 @@ -.. - This work is licensed under a Creative Commons Attribution 3.0 Unported - License. - - http://creativecommons.org/licenses/by/3.0/legalcode - -.. title:: - Doctor - **************************************** Doctor: Fault Management and Maintenance **************************************** @@ -41,7 +32,6 @@ Doctor: Fault Management and Maintenance 18.05.2015 Stable version of the Doctor deliverable ========== ===================================================== - .. raw:: latex \newpage @@ -63,7 +53,3 @@ Doctor: Fault Management and Maintenance .. include:: 99-references.rst - - -.. - vim: set tabstop=4 expandtab textwidth=80: diff --git a/etc/conf.py b/etc/conf.py deleted file mode 100644 index 05dbc4d3..00000000 --- a/etc/conf.py +++ /dev/null @@ -1,27 +0,0 @@ -import datetime -import sys -import os - -needs_sphinx = '1.3' - -numfig = True - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'Doctor', u'Doctor Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'Doctor: Fault Management and Maintenance' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' |