aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2017-03-23Cleanup `docs` folderYujun Zhang16-748/+0
- move legacy document to `/legacy/docs` - move proposals to `docs/proposal` - remove unused `.gitkeep` files Change-Id: I1ad83ae98b7a6b3bb1738ced9b1f0d22c9c296b6 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-23Sync docs from stable/danube 05ef2c4f46a9dc7a704a290eb15817c80a52c2e6Yujun Zhang11-6/+378
Change-Id: I519c002259143cc92417f34595a80889c93310e1 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-23Update CLI docs.Taseer2-0/+130
JIRA: QTIP-231 Change-Id: I44bc75239e9ff59a70ec9070092101f021a3a291 Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
2017-03-08Adding LabelsShubhamRathi1-0/+2
Labels serve as anchors/ refs when referenced from other documents This patch adds labels to docs/*/*/index.rst Change-Id: Id23477c82231a1d02463802d60ee9d88a7fabc41 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-03Restructure docsYujun Zhang21-0/+0
- Following the changes as in functest[1] since the guide[2] in wiki is a bit out of date - Some folders are empty for now as a placeholder Now: - release - release notes - testing - developer - design - overview - requirement - user - config guide - user guide - installation - scenarios [1]: https://gerrit.opnfv.org/gerrit/#/c/29151/ [2]: https://wiki.opnfv.org/display/DOC/Documentation+Guide Change-Id: I81b4597536c8bf02a925641d71d0969f6f5537f4 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-02-18Migrate to Danube document guideYujun Zhang26-85/+0
https://wiki.opnfv.org/display/DOC Change-Id: I85535f158022fe0aeb7c888273dc81fbbf4ddeda Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-01-11Yardstick integration design specificationwu.zhihui2-0/+93
Refer to https://etherpad.opnfv.org/p/qtip-yardstick, I write this design specification. JIRA: QTIP-147 Change-Id: I651c6ffd898fa22c237b788edab7e0a43828ae7c Signed-off-by: wu.zhihui <wu.zhihui1@zte.com.cn>
2016-11-25Fix test failingYujun Zhang2-7/+7
- skip several failure cases, to be fixed in future - rename `test_plan` to hide from test discovering - add pep8 check by default - fix errors in pep8 check Change-Id: If4451999a1f4ed1339dfdf8271cc58f11de72b3e Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-11-25Merge "Write how is compute QPI calculated."zhihui wu2-0/+70
2016-11-24Write how is compute QPI calculated.zhifeng.jiang2-0/+70
JIRA: QTIP-127 Change-Id: I2c5f3c3b2b968a9c2bb0a772a38924af60890a67 Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2016-11-16update path of test_plan in docswu.zhihui2-3/+3
JIRA: QTIP-155 Change-Id: Ic342c602a8bc4e304ef14c6bdb05b505f8fe8012 Signed-off-by: wu.zhihui <wu.zhihui1@zte.com.cn>
2016-11-08Merge "rename test_cases/ to test_plan/"zhihui wu2-7/+7
2016-11-08Merge "Update docs due to reorganize result directory"zhihui wu1-1/+1
2016-11-08Merge "Start qtip server in qtip-dev host and add the qtip restful api ↵zhihui wu1-1/+1
online url in docs."
2016-11-07Start qtip server in qtip-dev host and add the qtip restful api online url ↵zhifeng.jiang1-1/+1
in docs. JIRA:QTIP-111 Change-Id: I11c42c5d9033efeaf5b8525b1090c2d45a9597d8 Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2016-11-07rename test_cases/ to test_plan/wu.zhihui2-7/+7
JIRA: QTIP-131 Change-Id: I12c63b4f0ff0167073a0819bdb5d63ca0c6f06fb Signed-off-by: wu.zhihui <wu.zhihui1@zte.com.cn>
2016-11-07Add spec for time line diagramYujun Zhang1-0/+16
Change-Id: Ib3f5697f5afee294a469979bc66244f054edb1fd Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-11-07Merge "Spec for comparison view"Yujun Zhang1-0/+44
2016-11-07Merge "Update README"Yujun Zhang2-0/+92
2016-11-07Update docs due to reorganize result directorywu.zhihui1-1/+1
JIRA: QTIP-131 Change-Id: I8b70f4aeda66b2a33c28f4db09d7fef6e54672ec Signed-off-by: wu.zhihui <wu.zhihui1@zte.com.cn>
2016-11-07Spec for comparison viewYujun Zhang1-0/+44
JIRA: QTIP-128 Change-Id: Iade0b139416973dc228878b7ff42596d5d5a66fa Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-11-05Rename section "Deviation" to "Stats" and add more detailsYujun Zhang1-5/+26
JIRA: QTIP-129 Change-Id: I7159b4f3f2912b5f15aa8ccc128d59170d2c4b52 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-11-05Update READMEYujun Zhang2-0/+92
- archived the old README as release note of Brahmaputra - updated the project description Change-Id: Iad582aee45170701ec5df7c6dad5aa4a0935d95f JIRA: QTIP-144 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-11-01Outline of QPI dashboard design specification.Yujun Zhang2-0/+83
JIRA: QTIP-126 Change-Id: Id7f116fb479617d56edfb9b1513fd0fb508b6383 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-11-01Normalize headings according to "reStructuredText Primer"Yujun Zhang8-18/+19
[1]: http://www.sphinx-doc.org/en/stable/rest.html Change-Id: Ie7530846e0b3683118422ed6ce24e0cd5af94a6e Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-10-31Merge "Small amends in the documentation."Yujun Zhang1-3/+3
2016-10-30Fix doc8 warningYujun Zhang1-1/+1
Warning: rst validation (doc8) has failed, please fix the following error(s). docs/userguide/annex.rst:18: D005 No newline at end of file Change-Id: Idcb7a79337d1ea5e607ac238be5c68f1dec85edd Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-10-30Small amends in the documentation.linux_geek1-3/+3
Change-Id: Ic1c5a177f3fadd263443a83fb8a9319c5d9c6a8f Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
2016-10-25Make documents update to datazhifeng.jiang2-76/+56
modification: Leave only docker installation method Fix some errors due to path changes JIRA:QTIP-113 Change-Id: I18663d57df4c792f72cbde95806ecd6b3a6436e2 Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2016-10-19Fix warnings during sphinx-buildYujun Zhang4-22/+24
Change-Id: Iafc86372884c4a9d0f2a595b8b4d59818062b6a2 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-10-18Reorganize existing documentsYujun Zhang13-37/+61
- Align document structure with Colorado release - follow convention used in "Python’s Style Guide for documentating"[1] [1] https://docs.python.org/devguide/documenting.html#sections Change-Id: Idee6ad6e68a35e3fd84ec36de480722e0259011b JIRA: QTIP-117 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-10-18Deprecate docs/roadmapYujun Zhang2-113/+0
Content moved to https://wiki.opnfv.org/display/qtip/Vision JIRA: QTIP-117 Change-Id: I699a49d308e934a7d9d35befd0b8dd0624b5d36d Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-10-17bugfix due to directory adjustmentwu.zhihui1-1/+1
Some files still use directory "data/". Fix it. Change-Id: Ia07f380c3e9c3e312d17b09728b050c818492f0f Signed-off-by: wu.zhihui <wu.zhihui1@zte.com.cn>
2016-10-08Merge "Some small spelling errors."Yujun Zhang2-25/+25
2016-10-08Some small spelling errors.linux_geek2-25/+25
Change-Id: I566ce7755388d2efc2278e4dc4c91d67d217ecb0 Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
2016-09-30Fix broken links in docsYujun Zhang3-11/+9
JIRA: QTIP-100 Change-Id: If3f91b0d683ebd497bd3f8bc34b63ddd35877e01 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-09-30Merge "The original arguments were out of order. The docker name has to be ↵Yujun Zhang1-1/+1
after all the arguments, to be able to successfully run the docker."
2016-09-26Add qtip restful server usage in docs.zhifeng.jiang4-11/+82
modification: Add qtip restful api info in apidoc. Add qtip restful api usage in userguide. modify the test_list example. JIRA:QTIP-99 Change-Id: I0da640571fa0272376e735335fb364e6e20e8a4e Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2016-09-23The original arguments were out of order. The docker name has to be after ↵Taseer1-1/+1
all the arguments, to be able to successfully run the docker. Change-Id: I405c79c26be4d9fff90d5453a32af750323d44eb Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
2016-08-15Doc updates according to DOCS projectJulien15-204/+183
Upddating QTIP docs according to DOCS project wiki in: https://wiki.opnfv.org/display/DOC/Configurartion+guide and https://wiki.opnfv.org/display/DOC/Userguide JIRA: QTIP-102 Change-Id: Iab5bdcf3f290bc88d2fedc8a0153e26daf89cde8 Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
2016-08-09updates to use new doc toolchainRyota MIBU4-152/+0
Change-Id: I7598be048d64b43863f0a5699eafe0214a47ed93 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-14Fix pep8 errors for conf.pyzhifeng.jiang1-5/+2
JIRA:QTIP-89 Change-Id: I43ea5351fd9d1dcf157a0f7d06981cc9ff5d0ff0 Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2016-07-07First draft for release D roadmapYujun Zhang1-0/+100
Change-Id: I7c3785ed37e8287a2869eb97206aabc1fb87cc6a Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-05-17Add proxy info in sample-config.yaml and 03-usage-guide.rstzhifeng.jiang2-2/+32
JIRA:QTIP-73 Change-Id: I4cf5ee2f1bd7eeb79076b505cc51d607516410ed Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2016-05-14Correct some spelling mistakes.zhifeng.jiang1-8/+8
Change-Id: I990684afba696775abe07e8d4dd3ac4ade77cb61 Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2016-02-24Changed upstream links for playbooksNauman_Ahad1-0/+2
Upsream links such as OpenSSL may break. Changed these links to links hosted at artifacts.opnfv.org so that links don't break for B release branch Change-Id: I9ca5cacf27030446dfa59717855f60dc1544b422 Signed-off-by: Nauman_Ahad <nauman.ahad@xflowresearch.com>
2016-02-11Modifed documentation to generate improved PDFs in tool chainNauman_Ahad16-530/+608
Modified the location for documentation files within the docs directory. Index files modified to generate better PDFs Change-Id: Ie21b1021a8d09013df48afc6d737d95ee8aeed92 Signed-off-by: Nauman_Ahad <nauman_ahad@xflowresearch.com>
2016-02-02Bug Fixes for SSL index calculationNauman_Ahad1-3/+6
Index calcuation for SSL caused a ValueError when converting to float due to the presence of a trailing "k" character. This has ben resolved. Change-Id: I6f7d061977a3a8cbc2aa1afe154df5eeec9feac8 Signed-off-by: Nauman_Ahad <nauman_ahad@xflowresearch.com>
2016-01-21bug-fix: fix bug in docker run file, replace $$ with &&MofassirArif1-15/+16
Change-Id: Ic48483ae97aab2f844ee753cecf5fc3714a13cdb Signed-off-by: MofassirArif <Mofassir_Arif@dellteam.com>
2016-01-21bug fix: result collection bug fix for docker imagesMofassirArif3-67/+105
Change-Id: Ia4ea09b90c7a4f4e3699af456c6d66e85661cc0b Signed-off-by: MofassirArif <Mofassir_Arif@dellteam.com>