starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Replace model documentation modals with links to local docs #5425

New Issue
Closed
opened 2025-12-29 19:27:49 +01:00 by adam · 0 comments
adam commented 2025-12-29 19:27:49 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Sep 27, 2021).

Originally assigned to: @jeremystretch on GitHub.

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

Originally created by @jeremystretch on GitHub (Sep 27, 2021). Originally assigned to: @jeremystretch on GitHub. ### 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_
adam added the status: acceptedtype: feature labels 2025-12-29 19:27:49 +01:00
adam closed this issue 2025-12-29 19:27:49 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#5425
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?