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

Plugin Tool Tip Doc Error #3735

New Issue
Closed
opened 2025-12-29 18:30:50 +01:00 by adam · 2 comments
adam commented 2025-12-29 18:30:50 +01:00
Owner
Copy Link

Originally created by @ryanmerolle on GitHub (May 29, 2020).

Looks like doc pointers for view tool-tip need to be direct to a plugin directory. It also looks like we need set a standard in the docs on how plugin developers create place the associated docs in their structure. This is one of those bugs/feature request type issues.

Environment

  • Python version: 3.6.9
  • NetBox version: 2.8.5

Steps to Reproduce

  1. Install Netbox Plugin
  2. Within plugin page click tool-tip / doc question mark

Expected Behavior

Display Plugin Documentation

Observed Behavior

Unable to load documentation, file not found: /opt/netbox/docs/<plugin_name>/<plugin_model>.md

Originally created by @ryanmerolle on GitHub (May 29, 2020). Looks like doc pointers for view tool-tip need to be direct to a plugin directory. It also looks like we need set a standard in the docs on how plugin developers create place the associated docs in their structure. This is one of those bugs/feature request type issues. ### Environment * Python version: 3.6.9 * NetBox version: 2.8.5 ### Steps to Reproduce 1. Install Netbox Plugin 2. Within plugin page click tool-tip / doc question mark <!-- What did you expect to happen? --> ### Expected Behavior Display Plugin Documentation <!-- What happened instead? --> ### Observed Behavior `Unable to load documentation, file not found: /opt/netbox/docs/<plugin_name>/<plugin_model>.md`
adam closed this issue 2025-12-29 18:30:50 +01:00
adam commented 2025-12-29 18:30:51 +01:00
Author
Owner
Copy Link

@stale[bot] commented on GitHub (Jun 12, 2020):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our contributing guide.

@stale[bot] commented on GitHub (Jun 12, 2020): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 18:30:51 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 1, 2020):

This is caused by the get_docs template filter, which is used only in templates/obj_edit.html. This template is not provided as part of the plugins API.

@jeremystretch commented on GitHub (Jul 1, 2020): This is caused by the `get_docs` template filter, which is used only in `templates/obj_edit.html`. This template is not provided as part of the plugins API.
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
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#3735
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?