aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
AgeCommit message (Collapse)AuthorFilesLines
2017-03-07Renamed NEWS.rst to vsperf-release.rst and moved into release dir per new ↵Trevor Cooper1-6/+0
doc structure Remove reference to NEWS.rst in index file ... release notes will be referenced in Release section Change-Id: I8f32c7cd23b0b2cd33703950a71cbb626c0c35fc Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2017-03-02Updated project description and license headerTrevor Cooper1-12/+18
Change-Id: I122bdec1a7fa9a9e3da51acb31b30a231eff7890 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2017-01-30docs: Remove hyperlinks to docs in artifactsMartin Klozik1-7/+63
It is possible to use sphinx cross referencing feature in case, that only one level of toctree is used. Thus documentation was reorganized to utilize just one top level index with toctree. After that it was possible to use rst native syntax to create a cross links among vsperf documentation chapters. As a result only 2 hyperlinks to the yardstick documentation are version specific. JIRA: VSPERF-442 Change-Id: I15c2f53922e88765506448de61af4a299f5d53c5 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com> Reviewed-by: Martin Goldammer <martinx.goldammer@intel.com> Reviewed-by: Trevor Cooper <trevor.cooper@intel.com>
2017-01-24docs: Installation doc updatedMartin Klozik1-2/+2
Documentation was updated as follows: * description of vsperf downloading was added * VNF section was updated * additions to installation and virtualnev related parts * file permissions of all documentaton files was unified on 644 * README.md was updated with links to doc files and online docs * 3rd_party/readme was renamed and updated to follow markdown syntax JIRA: VSPERF-441 Change-Id: I648c6a8f0bb283bbc0875fd6fecd2539ca0c9056 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com> Reviewed-by: Martin Goldammer <martinx.goldammer@intel.com>
2016-02-16docs: results documentationMaryam Tahhan1-1/+1
Add a results directory and relevant rst files for vsperf brahmaputra results. Change-Id: I99ea7b4246b801054d2582933f7d25b7f36abe5d Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Billy O Mahony <billy.o.mahony@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christopher Price <christopher.price@ericsson.com>
2016-02-05docs: adding license to all rst files.Maryam Tahhan1-0/+4
Add Creative Commons Creative Commons license to all documentation in vsperf. JIRA: VSPERF-239 Change-Id: I88721205a36078f6e0d4a4c5dd842907729d2b6b Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Billy O Mahony <billy.o.mahony@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
2016-01-28docs: Final report conclusions and recommendationsMaryam Tahhan1-3/+3
Remove TODO sections from the Release B report. Change-Id: I4520c23ad9cbb980c9f1c1ee14cc7e91060933a4 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com>
2016-01-25docs: updates and final fixesMaryam Tahhan1-0/+33
Migrate the installation guide for vsperf to a configguide directory, update the links to the installation guide. Re-add top level index.rst and remove the all directory. Update release documentation with vsperf Rel B support. Change-Id: Ib643b9d3581d8109b85c377027c8cc6be4b797fc Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Radek Zetik <radekx.zetik@intel.com> Reviewed-by: Dino Simeon Madarang <dino.simeonx.madarang@intel.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
2015-12-21docs: updates and move traffic gens to separate docMaryam Tahhan1-16/+0
Move the traffic gen instructions to a separate user guide and add information on usage of the Dummy traffic generator. Update docs to fix PDF build failure and do general clean-up. Removed the numbering from the LTD and added the numbered directive to automate numbering for sections and headers. Add comment anchors that reflect the section numbers. Change-Id: I984ca38456a891c439697ebc1da041bc1d828a15 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2015-11-26doc: update template and conf filesRyota MIBU1-16/+2
JIRA: RELENG-16 Change-Id: I0aaac15c1d1a1031cbc113db594a342c60b7eb1d Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-11-04docs: reorganize docs for the sphinx buildRamprasad Velavarthipati1-0/+30
Reorganize docs into the appropriate folders for the new sphinx build. JIRA: VSPERF-80 Change-Id: I9dcd74e092ce52546a0986b92a1ebb2b5b7419bf Signed-off-by: Ramprasad Velavarthipati <ram.v@freescale.com> Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Trinath Somanchi <trinath.somanchi@gmail.com>