Re: [opnfv-tech-discuss] [OPNFV] [Danube] [Documentation] Organization of testing section

[morgan.richomme]

yes

see minutes
http://ircbot.wl.linuxfoundation.org/meetings/opnfv-testperf/2017/opnfv-testperf.2017-03-02-15.00.html
docs
├── release
│   └── release-notes
└── testing
├── developer
└── user

see https://git.opnfv.org/functest/tree/docs as an illustration

and for the title (not written in the minutes) we agree to try to find
consistant and descriptive titles
we can precise the name of the project, but the title must be
understandable by a new comer

e.g.
Functional testing User Guide (Functest)

so I assume for Qtip it should be something like
Benchmarking as a Service (Qtip)
but we could review that during the cross review period


Le 03/03/2017 à 02:11, Yujun Zhang (ZTE) a écrit :
> Have we get an agreement on the document structure now?
>
> Sorry that I missed yesterday's meeting. 
>
> --
> Yujun
>
> On Wed, Mar 1, 2017 at 9:54 PM  > wrote:
>
> 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  repo>/docs/testing/user
>
>   * OPNFV FUNCTEST user guide
> 
> 
>   * Bottlenecks - user guide
> 
> 
>   * Yardstick Overview
> 
> 
>   * VSPERF
> 
> 
>   * .
>
>
> in Developer, all the documents generated from  repo>/docs/testing/developer
>
> we probably should also adopt some conventions for the title to be
> as consistant as possible...
>
>   user guide
>
>  configuration guide
>
>  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]
>> *Sent:* den 1 mars 2017 08:27
>> *To:* Sofia Wallin > >; David McBride
>> mailto:dmcbr...@linuxfoundation.org>>
>> *Cc:* opnfv-tech-discuss@lists.opnfv.org
>> ; Yujun Zhang
>> mailto:zhangyujun+...@gmail.com>>;
>> mark.bei...@emc.com ; Jose Lausuch
>> mailto:jose.laus...@ericsson.com>>;
>> Cooper, Trevor > >; Yuyang (Gabriel)
>> mailto:gabriel.yuy...@huawei.com>>;
>> Gaoliang (D) > >
>> *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 

Re: [opnfv-tech-discuss] [OPNFV] [Danube] [Documentation] Organization of testing section

[Yujun Zhang (ZTE)]

Have we get an agreement on the document structure now?

Sorry that I missed yesterday's meeting.

--
Yujun

On Wed, Mar 1, 2017 at 9:54 PM  wrote:

> 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  repo>/docs/testing/user
>
>- OPNFV FUNCTEST user guide
>
> 
>- Bottlenecks - user guide
>
> 
>- Yardstick Overview
>
> 
>- VSPERF
>
>- .
>
>
> in Developer, all the documents generated from  repo>/docs/testing/developer
>
> we probably should also adopt some conventions for the title to be as
> consistant as possible...
>
>   user guide
>
>  configuration guide
>
>  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
> ]
> *Sent:* den 1 mars 2017 08:27
> *To:* Sofia Wallin ; David McBride <
> dmcbr...@linuxfoundation.org>
> *Cc:* opnfv-tech-discuss@lists.opnfv.org; Yujun Zhang <
> zhangyujun+...@gmail.com>; mark.bei...@emc.com; Jose Lausuch <
> jose.laus...@ericsson.com>; Cooper, Trevor ;
> Yuyang (Gabriel) ; Gaoliang (D) <
> 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
> /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 d

Re: [opnfv-tech-discuss] [OPNFV] [Danube] [Documentation] Organization of testing section

[morgan.richomme]

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 /docs/testing/user

  * OPNFV FUNCTEST user guide


  * Bottlenecks - user guide


  * Yardstick Overview


  * VSPERF

  * .


in Developer, all the documents generated from /docs/testing/developer

we probably should also adopt some conventions for the title to be as
consistant as possible...

  user guide

 configuration guide

 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]
> *Sent:* den 1 mars 2017 08:27
> *To:* Sofia Wallin  >; David McBride
> mailto:dmcbr...@linuxfoundation.org>>
> *Cc:* opnfv-tech-discuss@lists.opnfv.org
> ; Yujun Zhang
> mailto:zhangyujun+...@gmail.com>>;
> mark.bei...@emc.com ; Jose Lausuch
> mailto:jose.laus...@ericsson.com>>;
> Cooper, Trevor  >; Yuyang (Gabriel)
> mailto:gabriel.yuy...@huawei.com>>;
> Gaoliang (D) 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
> /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 peu

Re: [opnfv-tech-discuss] [OPNFV] [Danube] [Documentation] Organization of testing section

[Jose Lausuch]

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]
Sent: den 1 mars 2017 08:27
To: Sofia Wallin mailto:sofia.wal...@ericsson.com>>; 
David McBride 
mailto:dmcbr...@linuxfoundation.org>>
Cc: 
opnfv-tech-discuss@lists.opnfv.org; 
Yujun Zhang mailto:zhangyujun+...@gmail.com>>; 
mark.bei...@emc.com; Jose Lausuch 
mailto:jose.laus...@ericsson.com>>; Cooper, Trevor 
mailto:trevor.coo...@intel.com>>; Yuyang (Gabriel) 
mailto:gabriel.yuy...@huawei.com>>; Gaoliang (D) 
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
/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.
___
opnfv-tech-discuss mailing list
opnfv-tech-discuss@lists.opnfv.org
https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss

Re: [opnfv-tech-discuss] [OPNFV] [Danube] [Documentation] Organization of testing section

[Sofia Wallin]

Hi Morgan,
Yes – This is consistent with what we decided yesterday.

Thank you,
Sofia

From: morgan.richo...@orange.com [mailto:morgan.richo...@orange.com]
Sent: den 1 mars 2017 08:27
To: Sofia Wallin ; David McBride 

Cc: opnfv-tech-discuss@lists.opnfv.org; Yujun Zhang ; 
mark.bei...@emc.com; Jose Lausuch ; Cooper, Trevor 
; Yuyang (Gabriel) ; 
Gaoliang (D) 
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
/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.
___
opnfv-tech-discuss mailing list
opnfv-tech-discuss@lists.opnfv.org
https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss

[opnfv-tech-discuss] [OPNFV] [Danube] [Documentation] Organization of testing section

[morgan.richomme]

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
/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.

___
opnfv-tech-discuss mailing list
opnfv-tech-discuss@lists.opnfv.org
https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss