Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ArchNav is a highly versatile platform that supports a wide variety of use cases. However it One of the drivers for its creation seems to be in part as a workaround to existing documentation policies that are not being followed, (see  DeveloperWiki and ReadTheDocs Usage Policy)  The confusion created by not following the set documentation policy in all situations, in addition to the wiki being poorly structured,  has created the need for something like ArchNav to help the development community find the information they need.   However ArchNav brings complexity when designing a clickable image, The process requires taking a snapshot of an existing image, converting it to a PNG file (if not already a PNG), using an external tool to draw shapes around objects in the image to generate the needed coordinates and lastly to store the coordinate attributes in a JSON object. This has the potential to be more time-consuming and error-prone when compared to creating OVERLAYS using an SVG editor to create diagrams with embedded links.  SVGs with embedded links however have less versatility than ArchNav has demonstrated.

...

Documentation residing in the read the docs is always up to date and the most current. The ArchNav will require a separate manual update of the links pointing to the documentation in addition to the current RTD  updates whenever there is a new release of ONAP.  

  •  >capture need for infra' maintenance → budget

...

  • ramification beyond this eval, 

RECOMMENDATION

  • Implement a FACADE design pattern 

...