Skip to content

Replace model documentation modals with links to local docs #7372

@jeremystretch

Description

@jeremystretch

NetBox version

v3.0.3

Feature type

Change to existing functionality

Proposed functionality

When creating or editing most objects in NetBox, there is a "help" button at the top right corner of the page. When clicked, it reveals a floating modal with information about the object type, taken from the NetBox documentation.

This issues proposes converting this to a link which opens the relevant page in the actual docs directly, using the locally hosted documentation.

Use case

NetBox v3.0 introduced locally-hosted documentation for the application (see #6328), which obviates the need to render any of the source Markdown files directly within the application. Linking directly to the relevant documentation page provides a more consistent user experience.

Database changes

No response

External dependencies

No response

Metadata

Metadata

Assignees

Labels

status: acceptedThis issue has been accepted for implementationtype: featureIntroduction of new functionality to the application

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions