...
Architecture Navigator is a web-based tool that provides common access to the wiki and the Read The Docs documentation. It uses existing project diagrams and overlays the diagrams with clickable are maps. A clickable area object within the diagram is a visual representation of the individual ONAP projects which have hyperlinks embedded on them such that, when a user hovers a mouse over the object and clicks, they are redirected to the project documentation or the wiki.
The Architecture Navigator allows users to easily access the documentation that resides in the Read The Docs.
Current Version
| Project | Architecture Navigator |
|---|---|
| Release Name | dn |
| Release Version | 3.0 |
...
- Functionality
- Maintenance
- Infrastructure requirement
| ArchNav | Read The Docs | |
|---|---|---|
| FEATURES | Supported(Y/N) | Supported(Y/N) |
| Web-based | ||
| Stand alone | ||
| Dynamic | ||
| browser compatibility |
FUNCTIONALITIES
| Architecture Navigator | Read The Docs |
|---|---|
Technologies used include:
| Technologies used;
|
| Works on the browser | Works on the browser |
| Content is dynamically loaded as the user navigates to new pages. | |
| Offers quick access to documentation in a click. | Documentation is scattered and does not offer a straightforward way of looking up information. |
| Have embedded backlinks to the wiki. | Holds complete and formal technical documentation. |
| Clickable maps in the form of images. | Clickable maps in the form of an SVG diagram. |
INFRASTRUCTURE REQUIREMENTS
| ArchNav | Read The Docs |
|---|---|
MAINTENANCE
| ArchNav | Read The Docs |
|---|---|
| Requires user training on how to use the tool | Straight forward |
| Will require a team of technical contributors/committers | |