And just to precise - the last table from my first mail could be
mlisleading (we will exchange tomorrow during the weekly meeting)
you shall now create a docs/testing directory reflecting the target view
and put your docs there (as shown in Jose's patch)
in your repo
docs
├── release
│ └── release-notes
└── testing
├── developer
└── user
on docs.opnfv.org
we will get
Testing Documentation
* Overview
* User
* Developper
In Overview we will have our umbrella document
in User, all the documents generated from <test project
repo>/docs/testing/user
* OPNFV FUNCTEST user guide
<http://docs.opnfv.org/en/latest/submodules/functest/docs/userguide/index.html>
* Bottlenecks - user guide
<http://docs.opnfv.org/en/latest/submodules/bottlenecks/docs/userguide/index.html>
* Yardstick Overview
<http://docs.opnfv.org/en/latest/submodules/yardstick/docs/userguide/index.html>
* VSPERF
<http://docs.opnfv.org/en/latest/submodules/vswitchperf/docs/index.html>
* .....
in Developer, all the documents generated from <test project
repo>/docs/testing/developer
we probably should also adopt some conventions for the title to be as
consistant as possible...
<project> user guide
<project> configuration guide
<project> developer guide
to be agreed tomorrow
/Morgan
Le 01/03/2017 à 14:38, Jose Lausuch a écrit :
>
> Hi,
>
>
>
> Functest already following this approach:
> https://gerrit.opnfv.org/gerrit/#/c/29151/
>
>
>
> Thanks,
>
> Jose
>
>
>
> *From:*Sofia Wallin
> *Sent:* Wednesday, March 01, 2017 14:11 PM
> *To:* morgan.richo...@orange.com; David McBride
> *Cc:* opnfv-tech-discuss@lists.opnfv.org; Yujun Zhang;
> mark.bei...@emc.com; Jose Lausuch; Cooper, Trevor; Yuyang (Gabriel);
> Gaoliang (D)
> *Subject:* RE: [OPNFV] [Danube] [Documentation] Organization of
> testing section
>
>
>
> Hi Morgan,
>
> Yes – This is consistent with what we decided yesterday.
>
>
>
> Thank you,
>
> Sofia
>
>
>
> *From:*morgan.richo...@orange.com <mailto:morgan.richo...@orange.com>
> [mailto:morgan.richo...@orange.com]
> *Sent:* den 1 mars 2017 08:27
> *To:* Sofia Wallin <sofia.wal...@ericsson.com
> <mailto:sofia.wal...@ericsson.com>>; David McBride
> <dmcbr...@linuxfoundation.org <mailto:dmcbr...@linuxfoundation.org>>
> *Cc:* opnfv-tech-discuss@lists.opnfv.org
> <mailto:opnfv-tech-discuss@lists.opnfv.org>; Yujun Zhang
> <zhangyujun+...@gmail.com <mailto:zhangyujun+...@gmail.com>>;
> mark.bei...@emc.com <mailto:mark.bei...@emc.com>; Jose Lausuch
> <jose.laus...@ericsson.com <mailto:jose.laus...@ericsson.com>>;
> Cooper, Trevor <trevor.coo...@intel.com
> <mailto:trevor.coo...@intel.com>>; Yuyang (Gabriel)
> <gabriel.yuy...@huawei.com <mailto:gabriel.yuy...@huawei.com>>;
> Gaoliang (D) <jean.gaoli...@huawei.com <mailto:jean.gaoli...@huawei.com>>
> *Subject:* [OPNFV] [Danube] [Documentation] Organization of testing
> section
>
>
>
> Hi,
>
> during the last release meeting we had a discussion on the structure
> of the testing documentation for Danube
>
> we suggest to adopt the following approach for the test projects
>
> |/docs|
>
> ||_ release|
>
> |...|
> | |_ release-notes // release note of the projects involved in the
> release|
> | reference
> http://testresults.opnfv.org/reporting snapshot of the status at the
> release date|
> |...|
> ||_ testing|
>
> | testing overview // umbrella document => figure, description of
> the testing ecosystem, pointers to project documentation|
> | |__ user // will collect the documentation of the test
> projects allowing the end user to perform testing towards a OPNFV SUT|
> | e.g.
> Functest/Yardstick/Vsperf/Storperf/Bottlenecks/Qtip
> installation/config & user guides|
> | |__ developer // will collect documentation to explain how to
> create your own test case and leverage existing testing frameworks|
> | e.g. devloper guides|
>
>
>
> the umbrella testing documentation "testing overview" is under
> opnfvdocs => will be put into /testing
>
> the other documents are in the project repos under
> <repo>/docs
> /installation guide
> /config guide
> /user guide
> /release note
> /development
> /development guide
> / interships
>
> ----------------------------------------------------------------------------------
> | Test Project Repo | Target in
> docs.opnfv.org |
> ----------------------------------------------------------------------------------
> | installation, config, user guide |
> testing/user |
> | development guide | testing/developer |
> | release note |
> release-notes/testing |
> ----------------------------------------------------------------------------------
>
> @Sofia, David: is it OK for you?
>
> Morgan
>
> _________________________________________________________________________________________________________________________
>
> Ce message et ses pieces jointes peuvent contenir des informations
> confidentielles ou privilegiees et ne doivent donc
> pas etre diffuses, exploites ou copies sans autorisation. Si vous avez
> recu ce message par erreur, veuillez le signaler
> a l'expediteur et le detruire ainsi que les pieces jointes. Les
> messages electroniques etant susceptibles d'alteration,
> Orange decline toute responsabilite si ce message a ete altere,
> deforme ou falsifie. Merci.
>
> This message and its attachments may contain confidential or
> privileged information that may be protected by law;
> they should not be distributed, used or copied without authorisation.
> If you have received this email in error, please notify the sender and
> delete this message and its attachments.
> As emails may be altered, Orange is not liable for messages that have
> been modified, changed or falsified.
> Thank you.
--
Morgan Richomme
Orange/ IMT/ OLN/ CNC/ NCA/ SINA
Network architect for innovative services
Future of the Network community member
Open source Orange community manager
tel. +33 (0) 296 072 106
mob. +33 (0) 637 753 326
morgan.richo...@orange.com
_________________________________________________________________________________________________________________________
Ce message et ses pieces jointes peuvent contenir des informations
confidentielles ou privilegiees et ne doivent donc
pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce
message par erreur, veuillez le signaler
a l'expediteur et le detruire ainsi que les pieces jointes. Les messages
electroniques etant susceptibles d'alteration,
Orange decline toute responsabilite si ce message a ete altere, deforme ou
falsifie. Merci.
This message and its attachments may contain confidential or privileged
information that may be protected by law;
they should not be distributed, used or copied without authorisation.
If you have received this email in error, please notify the sender and delete
this message and its attachments.
As emails may be altered, Orange is not liable for messages that have been
modified, changed or falsified.
Thank you.
_______________________________________________
opnfv-tech-discuss mailing list
opnfv-tech-discuss@lists.opnfv.org
https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
