aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2017-05-09Include index files in master docYujun Zhang1-40/+4
some files were missing because we manually maintain the root index and it is out of sync with the child index Change-Id: If26474952931bfbfb9c7c2acf8331cbd54a1ccec Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-05-08Merge "Fix release notes link"zhihui wu1-2/+2
2017-05-06Fix release notes linkYujun Zhang1-2/+2
Change-Id: I1795768bfd89a297bf0f69e0d985ae995cf33a4c Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-05-04Update release note to Danube 2.0Yujun Zhang1-3/+12
Change-Id: I33eb6321d0349ab636ee99b616c7d326cc88d604 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn> (cherry picked from commit c868680eb17c2a7f86cb794e1cf15330f21dd3cd)
2017-04-27Add user guide about install from source codeYujun Zhang1-0/+20
Change-Id: Ieb4bbada9cd6375f4583a7cdc4ad7d995d2b6780 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-04-26Add developer guide for frameworkYujun Zhang2-0/+82
Change-Id: Iff4a45847ef12320afd3e64acfe32152e6ca0595 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-04-26Add user guide for using ansible-playbook to run QTIP benchmarksYujun Zhang2-0/+152
Change-Id: Ic04f83d91447944ed0fa507d6fffeed0a18b65fe Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-04-11Add document about how to release QTIP Python packageTaseer1-0/+11
JIRA: QTIP-240 Change-Id: Ie946504d9e52a889bc1dfe97248d45c205b1069f Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
2017-04-07Update index page for docs.qtip.ioYujun Zhang1-5/+18
Change-Id: If6d64dc29cda08550f613eaaad097a5ff1f2815b Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-04-05Merge "Add more comprehensive document example"Yujun Zhang2-0/+130
2017-04-02Add more comprehensive document exampleYujun Zhang2-0/+130
Change-Id: Ia414c692c7f91c4e071cdb4fb19637eb10adf11c Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-04-02Add instructions for releasingYujun Zhang1-0/+31
Change-Id: I9a76b0eaec0ba7630fc6915197c71ff93a62c1e3 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-04-02Add instructions about branchingYujun Zhang1-0/+19
Change-Id: Iecaabe34dcc2eabf520d0b2793edad26b4b0df79 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2017-03-31Merge "Update QTIP index"Yujun Zhang1-12/+11
2017-03-31Add guide for exposing api port during docker runakhilbatra8982-3/+2
Change-Id: I5dcc98ac02051f509c4714c6ea849f642dcae9d5 Signed-off-by: akhilbatra898 <akhil.batra@research.iiit.ac.in>
2017-03-31Merge "Replace Qtip with QTIP"Yujun Zhang2-18/+18
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