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

Provide custom help on form fields #4797

New Issue
Closed
opened 2025-12-29 19:20:35 +01:00 by adam · 2 comments
adam commented 2025-12-29 19:20:35 +01:00
Owner
Copy Link

Originally created by @bryanward-net on GitHub (Apr 19, 2021).

NetBox version

v2.11

Feature type

New functionality

Proposed functionality

Allow the creation/editing of Form Field context help to provide custom info to users of Netbox.
For example, right now, the "802.1Q Switching"->"802.1Q Mode" form has the context help of:
"""
Access: One untagged VLAN

Tagged: One untagged VLAN and/or one or more tagged VLANs

Tagged (All): Implies all VLANs are available (w/optional untagged VLAN)
"""

I'd like to edit that, and similar, for all form fields.

Use case

This would allow admins of a Netbox deployment to provide useful feedback to users of the deployment such as the following:
Interface Type: "Pick the fastest mode that the interface supports."
Interface MTU Field: "Gary, leave this blank, it doesn't do what you think it does."
VLAN Name: "Remember to use underscores instead of spaces and CamelCase per our internal standards"
etc.

Database changes

Unknown. These help messages seem to be hard-coded at the moment. Custom Fields have the ability to provide custom descriptions already, which is useful.

External dependencies

None

Originally created by @bryanward-net on GitHub (Apr 19, 2021). ### NetBox version v2.11 ### Feature type New functionality ### Proposed functionality Allow the creation/editing of Form Field context help to provide custom info to users of Netbox. For example, right now, the "802.1Q Switching"->"802.1Q Mode" form has the context help of: """ Access: One untagged VLAN<br /> Tagged: One untagged VLAN and/or one or more tagged VLANs<br /> Tagged (All): Implies all VLANs are available (w/optional untagged VLAN) """ I'd like to edit that, and similar, for all form fields. ### Use case This would allow admins of a Netbox deployment to provide useful feedback to users of the deployment such as the following: Interface Type: "Pick the fastest mode that the interface supports." Interface MTU Field: "Gary, leave this blank, it doesn't do what you think it does." VLAN Name: "Remember to use underscores instead of spaces and CamelCase per our internal standards" etc. ### Database changes Unknown. These help messages seem to be hard-coded at the moment. Custom Fields have the ability to provide custom descriptions already, which is useful. ### External dependencies None
adam added the type: featurepending closure labels 2025-12-29 19:20:35 +01:00
adam closed this issue 2025-12-29 19:20:36 +01:00
adam commented 2025-12-29 19:20:42 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Jun 19, 2021):

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.

@github-actions[bot] commented on GitHub (Jun 19, 2021): 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 19:20:44 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Jul 20, 2021):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@github-actions[bot] commented on GitHub (Jul 20, 2021): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
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 pending closure 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#4797
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?