Introducing Relationship Documentation and GenDocs generation modeling documentation

Owned by Michela Bevilacqua
Apr 27, 2020
1 min read



Background


In relation to ONAP IM Licensing model review during ONAP Frankfurt Release (License Model Review Comments), it has been proposed to introduce relationships in ONAP IM both in UML model proposal and in generated documentation by GenDocs.

https://lf-onap.atlassian.net/wiki/display/DW/Modeling+2020-03-31 

Presentation



ONAP IM JIRA

Following Jira tickets has been opened to document the activities.

ONAPMODEL-28 - Using the Documentation Property for Relationships Open  

ONAPMODEL-29 - Relationships in GenDocs generation modeling documentation Open



Using the Documentation Property for Relationships


Activities:

1) propose a UML model as example to experiment how to document different types of relationships

2) identify relavant information to be documented for different type of relationships

3) document in ONAP MODCOM wiki 




Relationships in GenDocs generation modeling documentation


Activities:

1) experiment how to export relevant relationships information by Gendocs