Skip to content

UI: Help Center #268

@DavidEdell

Description

@DavidEdell

The UI should include a more comprehensive Help page. Ideas include:

  • Detailed Version/Build information (see Improve Version reporting and tracking #267)
  • Existing ADMs listing, at least enhanced with an option to view raw yang files in browser instead of downloading
  • Enhanced User-friendly/HTML View of ADM definitions (may not currently exist)
  • Links to external documentation (Github, IETF Docs)
  • Link to REST API Documentation (http://localhost:5555/docs)
  • HTML Version of User Guide (ideally styled to match the UI).
    • It may be best for user guide to be cloned/generated when the anms-ui container is built to ensure users always have the latest documentation (even if deployed system is on an isolated network). Release-based branches in anms-docs can ensure consistency between releases.
  • Hook/documentation for user-deployments to append project-specific documentation links, including the option of hosting user-defined help files within the anms-ui container if desired.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    Status

    Done

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions