aboutsummaryrefslogtreecommitdiffstats
path: root/docs/templates
AgeCommit message (Collapse)AuthorFilesLines
2018-11-09[docs] Fix docs {un,}indent warnings in Testcase definitionsEmma Foley1-4/+4
Mostly, the issues were with un/indentation. This has been fixed, and `tox -e docs` now issues less warnings. JIRA: YARDSTICK-1416 Change-Id: Ie58a8dba42e9868357e1dce414cb1a01af8ad1f4 Signed-off-by: Emma Foley <emma.l.foley@intel.com> (cherry picked from commit 28e64c520fc2a52c1d3eb736f88ad4608b87c142)
2018-11-09[docs] Update header levelsEmma Foley1-0/+15
JIRA: YARDSTICK-1335 Change-Id: I202634a7427a409f0e2ca786c8bb5e05a5b4351d Signed-off-by: Emma Foley <emma.l.foley@intel.com> (cherry picked from commit 5456b070a8e05cd49d5626b002f6eeee71bcd67d)
2016-09-21Refine release note & Update scenario test resultsJingLu51-1/+1
JIRA: YARDSTICK-351 JIRA: YARDSTICK-354 Also fix a error in Yardstick_task_templates.rst Change-Id: Id9d091fce3afa7b0f62a08dfd6bca504aeaac805 Signed-off-by: JingLu5 <lvjing5@huawei.com>
2016-01-15HeatContext model update to match heat code updateQiLiang1-1/+1
In Heat Liberty release OS::Nova::Server will always use the user pre-configured in the image (e.g. "fedora" for stock Fedora cloud images, "ubuntu" for stock Ubuntu cloud images, "cloud-user" for stock CentOS cloud images etc) Change all ec2-user -> ubuntu Add admin-user in Heat model for backwards compatibility. Refer below links for detalis: https://etherpad.opnfv.org/p/yardstick_release_b_troubleshooting https://github.com/openstack/heat/commit/e423bec7f10b0f5d07f05d195b3b7860f6bceb00 http://blog.scottlowe.org/2015/04/23/ubuntu-openstack-heat-cloud-init/ JIRA: - Change-Id: I6b8b2b21daf113a3a86aee1126b0c3e74737ef4f Signed-off-by: QiLiang <liangqi1@huawei.com>
2016-01-14Add template for test results reportAna C1-0/+71
This change is a proposal for a report for yardstick test case reesults. One report for all the executed tests, summarizing the results and the labs where the tests were executed. JIRA: - Change-Id: I7cdfdc82d6ee07d2b9da426f33ce34b86362b5b4 Signed-off-by: Ana C <ana.cunha@ericsson.com>
2016-01-07Structure test case descriptionsAna C1-12/+31
This commit structures the test case descriptions. The file index.rst lists the subsequent chapters. 01-introduction.rst contains an overview of the project and deliverables. 02-methodology.rst describes the methodology for the generic test cases. 03-list-of-tcs.rst contains a list of merged generic test cases and a sub-chapter for the feature test cases. Glossary extracts definitions and abbreviations. TC001, TC002, TC008, TC009, TC010, TC012 were adapted to work for pdf. Template testcase_description_v2_template.rst was adapted to work for pdf. Change-Id: Ia11e27e5d508f1a784e2a412b50739e32b13797f Signed-off-by: Ana C <ana.cunha@ericsson.com>
2015-12-16Adapt documentation to latest guidelinesAna C3-117/+31
Adapt Yardstick documentation according to the latest guidelines from the Releng project. The only change in test case description TC001 and TC002 is to remove logo. The same for the test case description v2 template. The previous version of test case description is deleted from repo. The Yardstick_task_template is edited to keep line lenght 80 char. This commit also adds index for docs/yardstick and for docs/user_guides/framework. The overview for the vTC .rst file has been fixed to enable the .pdf generation. Change-Id: Ib6480c3c29ce0f0ee22c9ad717439f6a293ab842 Signed-off-by: Ana C <ana.cunha@ericsson.com>
2015-12-03Remove etc and source folder from yardstick documentationFatih Degirmenci3-0/+286
conf.py and logo will come from releng which is common for all projects. The directory structure in docs folder has not been decided yet so this change does not require you to change your current way of working. Once this directory structure is decided by opnfvdocs and releng, the changes need to be reflected back to all projects, including yardstick. Change-Id: If0558474a819f4a44e34f790d26c5486751b8266 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2015-09-16Move documentation to new sphinx buildAric Gardner1-88/+0
TODO: Reorganize documentation into properly named subfolders TODO: Add logos to documentation (see index.rst for example) Note you can see the results of this change via a link in the gerrit comments below NOTE: The merge job for your project has not been enabled, this code will not go to the artifacts page upon a merge. you can merge it and work on it in your own time, please contact me to enable the merge (the merge job will make this documentation avaliable to the public on artifacts.opnfv.org) JIRA:RELENG-15 Change-Id: I8fd519393416e2ac2b3ada6fe0670aa4d038fc87 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-07-15Add test case description templateAna C1-0/+88
Template states mandatory information for each test case to be delivered by Yardstick Project. JIRA: YARDSTICK-2 Change-Id: I16b98acc6689e24f8e6a85c356ee1b8991bd5276 Signed-off-by: Ana C <ana.cunha@ericsson.com>