Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Update Help page with doc links in the Web UI

Description

With 27.x we migrate from Maven-based AsciiDoc to Antora. We need to update the documentation links in the OpenNMS web UI. Additionally, we add Swagger UI for our REST API. We need to add the links for the OpenAPI doc and Swagger UI in the links as well.

FYI: The Swagger UI doesn't have a good backlink option, so it might be the easiest we open the Swagger UI in a new tab.

OpenAPI doc: http://localhost:8980/opennms/api/v2/openapi.json
Swagger UI: http://localhost:8980/opennms/api/v2/api-docs/?url=/opennms/api/v2/openapi.json#/

Acceptance / Success Criteria

None

Attachments

1

Lucidchart Diagrams

Activity

Show:

Jane Hou April 23, 2021 at 2:32 PM
Edited

https://github.com/OpenNMS/opennms/pull/3392

https://github.com/OpenNMS/opennms/pull/3395 

Note: not only the OpenAPI and Swagger UI stuff but there are also quite a bit of other worlding changes on this page, thanks to Bonnie for spending time and providing suggestions on this.

 

Antora link related stuff were backported to foundation-2021 

Fixed

Details

Assignee

Reporter

HB Grooming Date

HB Backlog Status

Components

Sprint

Fix versions

Affects versions

Priority

PagerDuty

Created March 31, 2021 at 8:01 AM
Updated May 11, 2021 at 2:29 AM
Resolved April 28, 2021 at 9:01 PM