Re: [opnfv-tech-discuss] [opnfvdocs] Documentation update for Danube release
Hi Morgan, Yes – I think this is the best place since it is common for all testing groups. BR, Sofia From: morgan.richo...@orange.com [mailto:morgan.richo...@orange.com] Sent: den 7 februari 2017 16:19 To: Sofia Wallin <sofia.wal...@ericsson.com>; Kunzmann, Gerald <kunzm...@docomolab-euro.com>; TECH-DISCUSS OPNFV (opnfv-tech-discuss@lists.opnfv.org) <opnfv-tech-discuss@lists.opnfv.org>; opnfv-project-le...@lists.opnfv.org Subject: Re: [opnfv-tech-discuss] [opnfvdocs] Documentation update for Danube release Hi Sofia For Danube, the testing group initiated an umbrella doc, currently hosted in opnfvdocs/docs/testing/ecosystem is it OK? Morgan Le 07/02/2017 à 15:49, Sofia Wallin a écrit : Hi Gerald, The documentation is divided into 3 different entry points/areas so the structure will look as following, /docs/release /configguide /installation /release-notes /scenarios └── scenario.name /userguide /docs/developer /design /overview /requirements /docs/testing So one more layer is added under /docs/ which will steer to where the documents will be generated and presented. Also, on the ML there had been the question on references in OPNFV documents? Was there any decision/solution on it? Please see answer from Chris on this. We have a docs meeting tomorrow where we could have a discussion about this. BR, Sofia From: Kunzmann, Gerald [mailto:kunzm...@docomolab-euro.com] Sent: den 7 februari 2017 14:35 To: Sofia Wallin <sofia.wal...@ericsson.com><mailto:sofia.wal...@ericsson.com>; TECH-DISCUSS OPNFV (opnfv-tech-discuss@lists.opnfv.org<mailto:opnfv-tech-discuss@lists.opnfv.org>) <opnfv-tech-discuss@lists.opnfv.org><mailto:opnfv-tech-discuss@lists.opnfv.org>; opnfv-project-le...@lists.opnfv.org<mailto:opnfv-project-le...@lists.opnfv.org> Subject: RE: [opnfv-tech-discuss] [opnfvdocs] Documentation update for Danube release Hi Sofia, Could you please highlight the “structural changes” that we should implement? Also, on the ML there had been the question on references in OPNFV documents? Was there any decision/solution on it? Best regards, Gerald From: opnfv-tech-discuss-boun...@lists.opnfv.org<mailto:opnfv-tech-discuss-boun...@lists.opnfv.org> [mailto:opnfv-tech-discuss-boun...@lists.opnfv.org] On Behalf Of Sofia Wallin Sent: Dienstag, 7. Februar 2017 14:26 To: TECH-DISCUSS OPNFV (opnfv-tech-discuss@lists.opnfv.org<mailto:opnfv-tech-discuss@lists.opnfv.org>) <opnfv-tech-discuss@lists.opnfv.org<mailto:opnfv-tech-discuss@lists.opnfv.org>>; opnfv-project-le...@lists.opnfv.org<mailto:opnfv-project-le...@lists.opnfv.org> Subject: [opnfv-tech-discuss] [opnfvdocs] Documentation update for Danube release To all projects that plans to contribute with documentation to the Danube release. Hi, As a reminder that documentation is part of the release even this time, following email contains some useful information and links. Since we are moving to read the docs<http://opnfv.readthedocs.io/en/latest/> (NOTE: this page is still work in progress) for the Danube release some structural changes has been made. Please have a look at the wiki page linked below to make sure that you store your documentation according to directives. Wiki Information on general documentation handling can be found here<https://wiki.opnfv.org/display/DOC> Milestones relevant for documentation is MS6 and MS10. MS6 17/2 – Preliminary documentation completed Documentation outlines or placeholders committed to repo for all project and release documentation MS10 24/3 – Documentation completed All project and release documentation reviewed and approved. Since we still haven’t manage to establish or communicate a review process for release related documentation it is important to always add one or two members from the docs project as reviewer on documentation related additions or changes. Everyone is welcome to join the docs meeting<https://wiki.opnfv.org/display/meetings/OPNFVDOCS> held every second week. Regards, Sofia ___ opnfv-tech-discuss mailing list opnfv-tech-discuss@lists.opnfv.org<mailto:opnfv-tech-discuss@lists.opnfv.org> https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss -- 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<mailto: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 copie
Re: [opnfv-tech-discuss] [opnfvdocs] Documentation update for Danube release
Hi Sofia For Danube, the testing group initiated an umbrella doc, currently hosted in opnfvdocs/docs/testing/ecosystem is it OK? Morgan Le 07/02/2017 à 15:49, Sofia Wallin a écrit : > > Hi Gerald, > > The documentation is divided into 3 different entry points/areas so > the structure will look as following, > > > > */docs/**release* > > /configguide > > /installation > > /release-notes > > /scenarios > > └── scenario.name > > /userguide > > > > */docs/developer* > > /design > > /overview > > /requirements > > > > */docs/testing* > > > > So one more layer is added under /docs/ which will steer to > where the documents will be generated and presented. > > > > Also, on the ML there had been the question on references in OPNFV > documents? Was there any decision/solution on it? > > Please see answer from Chris on this. We have a docs meeting tomorrow > where we could have a discussion about this. > > > > BR, > > Sofia > > > > *From:*Kunzmann, Gerald [mailto:kunzm...@docomolab-euro.com] > *Sent:* den 7 februari 2017 14:35 > *To:* Sofia Wallin <sofia.wal...@ericsson.com>; TECH-DISCUSS OPNFV > (opnfv-tech-discuss@lists.opnfv.org) > <opnfv-tech-discuss@lists.opnfv.org>; opnfv-project-le...@lists.opnfv.org > *Subject:* RE: [opnfv-tech-discuss] [opnfvdocs] Documentation update > for Danube release > > > > Hi Sofia, > > > > Could you please highlight the “structural changes” that we should > implement? > > > > Also, on the ML there had been the question on references in OPNFV > documents? Was there any decision/solution on it? > > > > Best regards, > > Gerald > > > > *From:*opnfv-tech-discuss-boun...@lists.opnfv.org > <mailto:opnfv-tech-discuss-boun...@lists.opnfv.org> > [mailto:opnfv-tech-discuss-boun...@lists.opnfv.org] *On Behalf Of > *Sofia Wallin > *Sent:* Dienstag, 7. Februar 2017 14:26 > *To:* TECH-DISCUSS OPNFV (opnfv-tech-discuss@lists.opnfv.org > <mailto:opnfv-tech-discuss@lists.opnfv.org>) > <opnfv-tech-discuss@lists.opnfv.org > <mailto:opnfv-tech-discuss@lists.opnfv.org>>; > opnfv-project-le...@lists.opnfv.org > <mailto:opnfv-project-le...@lists.opnfv.org> > *Subject:* [opnfv-tech-discuss] [opnfvdocs] Documentation update for > Danube release > > > > *To all projects that plans to contribute with documentation to the > Danube release.*** > > > > Hi, > > As a reminder that documentation is part of the release even this > time, following email contains some useful information and links. > > > > Since we are moving to read the docs > <http://opnfv.readthedocs.io/en/latest/> (NOTE: this page is still > work in progress) for the Danube release some structural changes has > been made. Please have a look at the wiki page linked below to make > sure that you store your documentation according to directives. > > > > _Wiki_ > > Information on general documentation handling can be found here > <https://wiki.opnfv.org/display/DOC> > > > > _Milestones relevant for documentation is MS6 and MS10._ > > MS6 17/2 – Preliminary documentation completed > > Documentation outlines or placeholders committed to repo for all > project and release documentation > > MS10 24/3 – Documentation completed > > All project and release documentation reviewed and approved. > > > > Since we still haven’t manage to establish or communicate a review > process for release related documentation it is important to always > add one or two members from the docs project as reviewer on > documentation related additions or changes. > > > > Everyone is welcome to join the docs meeting > <https://wiki.opnfv.org/display/meetings/OPNFVDOCS> held every second > week. > > > > Regards, > > Sofia > > > > ___ > opnfv-tech-discuss mailing list > opnfv-tech-discuss@lists.opnfv.org > https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss -- 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 confidentiel
Re: [opnfv-tech-discuss] [opnfvdocs] Documentation update for Danube release
Hi Gerald, The documentation is divided into 3 different entry points/areas so the structure will look as following, /docs/release /configguide /installation /release-notes /scenarios └── scenario.name /userguide /docs/developer /design /overview /requirements /docs/testing So one more layer is added under /docs/ which will steer to where the documents will be generated and presented. Also, on the ML there had been the question on references in OPNFV documents? Was there any decision/solution on it? Please see answer from Chris on this. We have a docs meeting tomorrow where we could have a discussion about this. BR, Sofia From: Kunzmann, Gerald [mailto:kunzm...@docomolab-euro.com] Sent: den 7 februari 2017 14:35 To: Sofia Wallin <sofia.wal...@ericsson.com>; TECH-DISCUSS OPNFV (opnfv-tech-discuss@lists.opnfv.org) <opnfv-tech-discuss@lists.opnfv.org>; opnfv-project-le...@lists.opnfv.org Subject: RE: [opnfv-tech-discuss] [opnfvdocs] Documentation update for Danube release Hi Sofia, Could you please highlight the "structural changes" that we should implement? Also, on the ML there had been the question on references in OPNFV documents? Was there any decision/solution on it? Best regards, Gerald From: opnfv-tech-discuss-boun...@lists.opnfv.org<mailto:opnfv-tech-discuss-boun...@lists.opnfv.org> [mailto:opnfv-tech-discuss-boun...@lists.opnfv.org] On Behalf Of Sofia Wallin Sent: Dienstag, 7. Februar 2017 14:26 To: TECH-DISCUSS OPNFV (opnfv-tech-discuss@lists.opnfv.org<mailto:opnfv-tech-discuss@lists.opnfv.org>) <opnfv-tech-discuss@lists.opnfv.org<mailto:opnfv-tech-discuss@lists.opnfv.org>>; opnfv-project-le...@lists.opnfv.org<mailto:opnfv-project-le...@lists.opnfv.org> Subject: [opnfv-tech-discuss] [opnfvdocs] Documentation update for Danube release To all projects that plans to contribute with documentation to the Danube release. Hi, As a reminder that documentation is part of the release even this time, following email contains some useful information and links. Since we are moving to read the docs<http://opnfv.readthedocs.io/en/latest/> (NOTE: this page is still work in progress) for the Danube release some structural changes has been made. Please have a look at the wiki page linked below to make sure that you store your documentation according to directives. Wiki Information on general documentation handling can be found here<https://wiki.opnfv.org/display/DOC> Milestones relevant for documentation is MS6 and MS10. MS6 17/2 - Preliminary documentation completed Documentation outlines or placeholders committed to repo for all project and release documentation MS10 24/3 - Documentation completed All project and release documentation reviewed and approved. Since we still haven't manage to establish or communicate a review process for release related documentation it is important to always add one or two members from the docs project as reviewer on documentation related additions or changes. Everyone is welcome to join the docs meeting<https://wiki.opnfv.org/display/meetings/OPNFVDOCS> held every second week. Regards, Sofia ___ opnfv-tech-discuss mailing list opnfv-tech-discuss@lists.opnfv.org https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
