Thanks very much for the quick and comprehensive reply Greg. Where there appears to be duplication, for example an architecture description, should the RTD be taken as the source of truth, as its been formally approved? If so, should there be a background effort to remove duplicate content from the wiki?
Frank Sandoval [email protected] OAM Technologies, representing Arm OOF committer > On Jun 14, 2018, at 12:27 PM, GLOVER, GREG L <[email protected]> wrote: > > Thanks Frank, > > Great question, I’ve copied ONAP discuss list since the answer pertains to > all ONAP documentation: > > Wiki: Is for informal content. That would include general community interest > (welcome, membership, announcements, meetings), and project work in progress > (e.g. team members, new topics being proposed, draft notes, discussion > threads, etc.). The wiki is intended as an “open” community-based mechanism > for anyone to provide input, questions, suggestions, etc. on any topic . > > Readthedocs: Is for approved, release-based change controlled content. The > Beijing artifacts can be found here: http://onap.readthedocs.io/en/beijing/ > <http://onap.readthedocs.io/en/beijing/>. The categories of documentation in > readthedocs includes formal release notes, architecture, development > guidelines, and user guides. Templates for all these sections can be found > here: > http://onap.readthedocs.io/en/beijing/guides/onap-developer/how-to-use-docs/include-documentation.html#templates-and-examples > > <http://onap.readthedocs.io/en/beijing/guides/onap-developer/how-to-use-docs/include-documentation.html#templates-and-examples>. > RTD is intended as a more formal mechanism to house “official” ONAP > artifacts. As such changes or additions to documentation requires review and > approval via the formal commit process. > > Regarding links to the wiki, generally there should not be a need to link > from RTD. Most likely the links you are seeing are primarily accessing > original seed content (pre-Amsterdam) that the Doc team is still in the > process of converting to ReStructured text and migrating to RTD. > > > From: Frank Sandoval <[email protected]> > Sent: Thursday, June 14, 2018 12:36 PM > To: GLOVER, GREG L <[email protected]>; BENNETT, RICH <[email protected]>; > PUZHAVAKATH NARAYANAN, SHANKARANARAYANAN <[email protected]> > Subject: RTD and wiki > > Hi Greg, Rich, > > I’ve been working on OOF documentation and I’d like to clarify the > relationship between RTD and wiki, as I sometimes come across links into the > wiki from RTD. > > What is the intended audiences for each set of material? > Are there guidelines for when to direct a reader of RTD to the wiki? > > Thanks > > > Frank Sandoval > [email protected] <mailto:[email protected]> > OAM Technologies, representing Arm > OOF committer
_______________________________________________ onap-discuss mailing list [email protected] https://lists.onap.org/mailman/listinfo/onap-discuss
