Hi Gerald,
The documentation is divided into 3 different entry points/areas so the
structure will look as following,
<repo>/docs/release
/configguide
/installation
/release-notes
/scenarios
└── scenario.name
/userguide
<repo>/docs/developer
/design
/overview
/requirements
<repo>/docs/testing
So one more layer is added under <repo>/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:[email protected]]
Sent: den 7 februari 2017 14:35
To: Sofia Wallin <[email protected]>; TECH-DISCUSS OPNFV
([email protected]) <[email protected]>;
[email protected]
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:
[email protected]<mailto:[email protected]>
[mailto:[email protected]] On Behalf Of Sofia Wallin
Sent: Dienstag, 7. Februar 2017 14:26
To: TECH-DISCUSS OPNFV
([email protected]<mailto:[email protected]>)
<[email protected]<mailto:[email protected]>>;
[email protected]<mailto:[email protected]>
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
[email protected]
https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
