diff options
| -rw-r--r-- | CONTRIBUTING.rst | 19 | ||||
| -rw-r--r-- | docs/apidocs/index.rst | 4 | ||||
| -rw-r--r-- | docs/apidocs/qtip_restful_api.rst | 4 | ||||
| -rw-r--r-- | docs/configguide/configuration.rst | 8 | ||||
| -rw-r--r-- | docs/configguide/index.rst | 4 | ||||
| -rw-r--r-- | docs/overview/index.rst | 5 | ||||
| -rw-r--r-- | docs/overview/overview.rst | 4 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 4 | ||||
| -rw-r--r-- | docs/userguide/introduction.rst | 4 |
9 files changed, 37 insertions, 19 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d3e21b80..6350a862 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -56,6 +56,22 @@ Specially, it is recommended to link each patch set with a JIRA issue. Put in commit message to create an automatic link. +************* +Documentation +************* + +The documents are built automatically by sphinx from reStructuredText (reST). +Please read `reStructuredText Primer`_ if you are not familiar with it. + +A cheat sheet for headings are as following + +* # with overline, for parts +* * with overline, for chapters +* =, for sections +* -, for subsections +* ^, for subsubsections +* ", for paragraphs + ************************ Frequent Asked Questions ************************ @@ -76,4 +92,5 @@ to submit. The current members are listed in `INFO`_. .. _OPNFV Releases: https://wiki.opnfv.org/display/SWREL .. _Issue Types: https://jira.opnfv.org/secure/ShowConstantsHelp.jspa?decorator=popup#IssueTypes .. _OpenStack Style Guidelines: http://docs.openstack.org/developer/hacking/ -.. _INFO: https://git.opnfv.org/cgit/qtip/tree/INFO
\ No newline at end of file +.. _INFO: https://git.opnfv.org/cgit/qtip/tree/INFO +.. _reStructuredText Primer: http://www.sphinx-doc.org/en/stable/rest.html diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst index 916fab08..241a2680 100644 --- a/docs/apidocs/index.rst +++ b/docs/apidocs/index.rst @@ -3,9 +3,9 @@ .. (c) 2015 Dell Inc. .. (c) 2016 ZTE Corp. -**************** +################ QTIP Configguide -**************** +################ .. toctree:: :maxdepth: 2 diff --git a/docs/apidocs/qtip_restful_api.rst b/docs/apidocs/qtip_restful_api.rst index ca77224c..3f3297d5 100644 --- a/docs/apidocs/qtip_restful_api.rst +++ b/docs/apidocs/qtip_restful_api.rst @@ -3,8 +3,8 @@ .. (c) 2015 Dell Inc. .. (c) 2016 ZTE Corp. - +**************** Qtip restful api -================ +**************** You can get all the Qtip restful api by http://qtip_server_ip:5000/api/spec.html. diff --git a/docs/configguide/configuration.rst b/docs/configguide/configuration.rst index d6d2fd5d..78e96492 100644 --- a/docs/configguide/configuration.rst +++ b/docs/configguide/configuration.rst @@ -16,7 +16,7 @@ to configure OPNFV with this specific installer Installing QTIP using Docker -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +============================ QTIP has a Docker images on the docker hub. Pulling opnfv/qtip docker image from docker hub: @@ -50,11 +50,11 @@ be navigated to using the following command. OpenStack parameters and credentials -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +==================================== Environment variables -""""""""""""""""""""" +--------------------- Before running QTIP it is necessary to export OpenStack environment variables from the OpenStack *openrc* file. This can be done by running the following @@ -69,7 +69,7 @@ environment variables. QTIP default key pair -"""""""""""""""""""""" +---------------------- QTIP uses a SSH key pair to connect to the guest image. You should generate key pair before running QTIP test. And put key pair in the ``config/`` directory. diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst index 291a809b..d5e05d63 100644 --- a/docs/configguide/index.rst +++ b/docs/configguide/index.rst @@ -4,9 +4,9 @@ .. (c) 2016 ZTE Corp. -================= +################# QTIP Config Guide -================= +################# .. toctree:: :maxdepth: 2 diff --git a/docs/overview/index.rst b/docs/overview/index.rst index 731b8d49..9a387360 100644 --- a/docs/overview/index.rst +++ b/docs/overview/index.rst @@ -3,9 +3,10 @@ .. (c) 2016 ZTE Corp. -===================== + +##################### QTIP Project Overview -===================== +##################### .. toctree:: :maxdepth: 2 diff --git a/docs/overview/overview.rst b/docs/overview/overview.rst index aa09c7c3..4fd42356 100644 --- a/docs/overview/overview.rst +++ b/docs/overview/overview.rst @@ -3,9 +3,9 @@ .. (c) 2015 Dell Inc. .. (c) 2016 ZTE Corp. -======== +******** Overview -======== +******** .. _QTIP: https://wiki.opnfv.org/platform_performance_benchmarking diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 5ae4f345..4be3e498 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -4,9 +4,9 @@ .. (c) 2016 ZTE Corp. -=============== +############### QTIP User Guide -=============== +############### .. toctree:: :maxdepth: 2 diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst index 4876d0e2..d0d9f3c1 100644 --- a/docs/userguide/introduction.rst +++ b/docs/userguide/introduction.rst @@ -13,8 +13,8 @@ run QTIP the first time when the user pull QTIP image on to their host machine. In order to install and config QTIP please follow the instructions in the configuration.rst located in docs/configguide/configuration.rst. -QTIP Directory structure: -------------------------- +QTIP Directory structure +======================== The QTIP directory has been sectioned off into multiple folders to facilitate segmenting information into relevant categories. The folders that concern |