Page tree
Skip to end of metadata
Go to start of metadata

 

Danube documentation review tracking

An easy way to see how the doc files are organized and view files ... https://git.opnfv.org/vswitchperf/tree/docs

Either edit files directly and push a patch (preferred) or send your comments/edits to Trevor Cooper

 

SectionFile / locationReviewer/sChecked contentChecked formatting, grammar, ...
Installation

https://git.opnfv.org/vswitchperf/tree/docs/configguide/installation.rst

Mars ToktonalievYesYes.
Traffic Gen Guidehttps://git.opnfv.org/vswitchperf/tree/docs/configguide/trafficgen.rst

Christian Trautman

Martin Klozik (Ixia & Dummy)

Yes

 

Yes

Yes

 

Yes

Upgrading vswitchperfhttps://git.opnfv.org/vswitchperf/tree/docs/configguide/upgrade.rst

Martin Klozik

YesYes
Traffic Gen Integration Guidehttps://git.opnfv.org/vswitchperf/tree/docs/design/trafficgen_integration_guide.rstTrevor Cooper  
Design Documenthttps://git.opnfv.org/vswitchperf/tree/docs/design/vswitchperf_design.rstAl Morton

I see some problems needing fix, primarily related to the Pod re-assignment.

3/23 Fixed POD refs and updated to stable ... Trevor Cooper

 
Release Noteshttps://git.opnfv.org/vswitchperf/tree/docs/release/release-notes/vsperf-release.rstTrevor CooperYesYes
Test Designhttps://git.opnfv.org/vswitchperf/tree/docs/requirements/vswitchperf_ltd.rst   
Test Planhttps://git.opnfv.org/vswitchperf/tree/docs/requirements/vswitchperf_ltp.rstTrevor Cooper  
Integration testshttps://git.opnfv.org/vswitchperf/tree/docs/userguide/integration.rstMartin KlozikYesYes
Step driven testshttps://git.opnfv.org/vswitchperf/tree/docs/userguide/teststeps.rstMartin KlozikYesYes
Test user guidehttps://git.opnfv.org/vswitchperf/tree/docs/userguide/testusage.rstChristian TrautmanYesYes
Execution with Yardstickhttps://git.opnfv.org/vswitchperf/tree/docs/userguide/yardstick.rstTrevor Cooper  

 


Danube test documentation organization

Proposal for organizing all documentation in test projects for "user" and "developer". 

This is the currently proposed way of organizing vsperf documentation content ...

 

docs/release/release-notes/vsperf-release.rst (NEWS content here)

 

docs/index.rst (project description)

docs/msc

docs/testing/developer/devguide/index.rst

docs/testing/developer/devguide/design

  • trafficgen_integration_guide
  • vswitchperf_design

docs/testing/developer/devguide/requirements

  • ietf_draft
    • *.xml
  • vswitchperf_ltd
  • vswitchperf_ltp

 docs/testing/user/configguide/index.rst

  • installation
  • trafficgen
  • upgrade

 docs/testing/user/userguide/index.rst

  • integration
  • teststeps
  • testusage
  • yardstick

 docs/testing/user/results/index.rst

  • results
  • scenario


Colorado vsperf documentation was organized as follows ...

configguide

  • installation
  • trafficgen
  • upgrade

 design

  • trafficgen_integration_guide
  • vswitchperf_design

 index.rst

 msc

 release

  • NEWS

 requirements

  • ietf_draft
    • *.xml
  • vswitchperf_ltd
  • vswitchperf_ltp

 results

  • results
  • scenario

 userguide

  • integration
  • teststeps
  • testusage
  • yardstick

 

 

 

 

 

  • No labels