aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2017-03-31Replace Qtip with QTIPYujun Zhang2-18/+18
Change-Id: I4f187f86f5bb519d836864778f815fcea2fa9545 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-31Fix document titleYujun Zhang1-3/+3
Change-Id: Ie4865676420fc573ebba6f019f5bbfafdf3e38b4 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-30Add missing license headerYujun Zhang1-0/+3
Change-Id: Ifd9015b50ef05040b8eb90a3ad3e3edddfd61811 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-30Update QTIP indexYujun Zhang1-12/+11
Change-Id: I57ec7d8e2558ce27b6a6acad6a8ec6d9ee0080f7 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-30Create release note for Danube 1.0Yujun Zhang1-87/+72
Change-Id: I68cdb0ba44b6296207ebdd9129f33220962d4bc0 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-30Normalize all section headersYujun Zhang12-64/+72
- folder with `index.rst` for parts, using # with overline for heading - `*.rst` file for chapter, using * with overline for heading In each *.rst file, use the following token for heading - =, for sections - -, for subsections - ^, for subsubsections - ", for paragraphs Change-Id: I6c247c1f1e27e891d0dade099195ef521f7dbb72 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-30Merge "Add more content to developer overview"Yujun Zhang1-15/+78
2017-03-29Add path for QTIP docsakhilbatra8981-0/+43
This file will serve as the index page of QTIP isolated documentation on qtip.readthedoc.org and docs.qtip.io Change-Id: I34315e62847bc1bdc970db9b400138c3640c9ed5 Signed-off-by: akhilbatra898 <akhil.batra@research.iiit.ac.in>
2017-03-29Add more content to developer overviewYujun Zhang1-15/+78
- copy "Coding Style" from `CONTRIBUTING.md` - copy "Testing" from `DEVELOP.md` - add links of primary packages Change-Id: Ia4da2c610a3ceb41ec710904e9437b0449d0a46f Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-28Merge "Align folder structure `docs/testing/developer` to opnfvdocs template"Yujun Zhang3-0/+1
2017-03-28Merge "Add project introduction"Yujun Zhang2-0/+33
2017-03-28Merge "update user docs"Yujun Zhang2-95/+103
2017-03-28Add project introductionYujun Zhang2-0/+33
Change-Id: I5d0553f0ccec571f9db90b2fd8f25f0941f00b03 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-28Merge "cite danube.rst in index.rst"Yujun Zhang1-0/+1
2017-03-28Merge "Add API docs"Yujun Zhang3-2/+329
2017-03-28Merge "Add overview in developer guide"Yujun Zhang2-0/+28
2017-03-28update user docswu.zhihui2-95/+103
Change-Id: I7a7a1343c457fe1c3063dfeafa079154d495eac0 Signed-off-by: wu.zhihui <wu.zhihui1@zte.com.cn>
2017-03-27Add info about selective runningTaseer1-0/+6
Change-Id: Ic5f7969c3d3969b7790d17beec10d73991ca8d08 Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
2017-03-27Add overview in developer guideYujun Zhang2-0/+28
Change-Id: I491f921d87cf0cec3bbef5a78e9f3065b1e012a1 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-27cite danube.rst in index.rstSerenaFeng1-0/+1
Change-Id: I00aa92a22e4e6aabd69463f3dd97d5d4a58f1e3a Signed-off-by: SerenaFeng <feng.xiaowei@zte.com.cn>
2017-03-27Add API docsakhilbatra8983-2/+329
- Add developer guide for API - Add user guide for API - Add api to user guide doctree JIRA: QTIP-234 Change-Id: Id388f82c52e31b3c75599ab846e64431be8083b7 Signed-off-by: akhilbatra898 <akhil.batra@research.iiit.ac.in>
2017-03-27Align folder structure `docs/testing/developer` to opnfvdocs templateYujun Zhang3-0/+1
Change-Id: I9ce069cf4b5384b5788ca7cfc70e4188519667d5 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-25Merge "Update CLI docs."Yujun Zhang1-4/+17
2017-03-24Update CLI docs.Taseer1-4/+17
- Update command to execute runner - Include reporter JIRA: QTIP-231 Change-Id: I834ac94821cea7221078fbb6160ef7467b2bd4cf Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
2017-03-23Rename docs/testing/developer/design to docs/testing/developer/devguideYujun Zhang7-0/+0
See https://git.opnfv.org/opnfvdocs/tree/docs/testing/testing-dev.rst Change-Id: Iac14adf4a2876fd74972dcf6279f7022e92cb9b5 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
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>