diff options
| author |   Justin-chi <chigang@huawei.com> | 2016-01-17 16:23:12 +0800 |
|---|---|---|
| committer | Justin chi <chigang@huawei.com> | 2016-01-29 01:01:35 +0000 |
| commit | b4e0803c49159105521ecf08275b1b9a1a4333bd (patch) | |
| tree | 7bf8d80e03b9a5932e1bff97b807a29e985a89e8 /docs/how-to-use-compass4nfv | |
| parent | 117e7f19652f4132f50b3f30010fa6dc38b8a468 (diff) | |
Document update for Brahmaputra
JIRA: COMPASS-75
add installation instruction
add FAQ.rst(draft) and release-notes(draft)
add some correction
Change-Id: I8fc48c79eeea06bc2efafce2eca72ebd9b71be16
Signed-off-by: Justin-chi <chigang@huawei.com>
(cherry picked from commit 080b1de19bc76a3e4435a73151d180d2267e4e59)
Diffstat (limited to 'docs/how-to-use-compass4nfv')
| -rw-r--r-- | docs/how-to-use-compass4nfv/documentation-compass4nfv.rst | 42 | ||||
| -rw-r--r-- | docs/how-to-use-compass4nfv/index.rst | 13 |
2 files changed, 13 insertions, 42 deletions
diff --git a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst b/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst index c9e40dd7..7fbd1578 100644 --- a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst +++ b/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst @@ -544,45 +544,3 @@ How to integration plugins - - - - - - -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-compass4nfv/index.rst b/docs/how-to-use-compass4nfv/index.rst new file mode 100644 index 00000000..f4a5bdeb --- /dev/null +++ b/docs/how-to-use-compass4nfv/index.rst @@ -0,0 +1,13 @@ +********************* +Compass4nfv Project +********************* + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + how-to-use-compass4nfv/documentation-compass4nfv.rst + how-to-use-compass4nfv/compass4nfv_host_network.png + how-to-use-compass4nfv/compass4nfv_network_topology.png |