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

Add markdown rendering to custom scripts' description #4644

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

Originally created by @rodvand on GitHub (Mar 10, 2021).

Originally assigned to: @rodvand on GitHub.

NetBox version

v2.10.4

Feature type

Change to existing functionality

Proposed functionality

In custom scripts, the Meta.description on each custom script is rendered as plain text. I propose to add the template tag |render_markdown in the netbox/templates/extras/script.html and script_list.html wherever the {{ script.Meta.description }} is referenced.

Use case

Custom scripts can sometimes become a bit "big" and not so easy to understand from a user's perspective and I would like to be able to add a link to a guide in the description of the script. I see this has been suggested before in https://github.com/netbox-community/netbox/issues/5082 but the workaround posted in that is not working, and I can't understand that it has ever worked looking at the code.

Database changes

None

External dependencies

None

As Custom Scripts descriptions today are only plain text I can't see the addition of markdown rendering doing any harm.

Originally created by @rodvand on GitHub (Mar 10, 2021). Originally assigned to: @rodvand on GitHub. ### NetBox version v2.10.4 ### Feature type Change to existing functionality ### Proposed functionality In custom scripts, the Meta.description on each custom script is rendered as plain text. I propose to add the template tag |render_markdown in the netbox/templates/extras/script.html and script_list.html wherever the {{ script.Meta.description }} is referenced. ### Use case Custom scripts can sometimes become a bit "big" and not so easy to understand from a user's perspective and I would like to be able to add a link to a guide in the description of the script. I see this has been suggested before in https://github.com/netbox-community/netbox/issues/5082 but the workaround posted in that is not working, and I can't understand that it has ever worked looking at the code. ### Database changes None ### External dependencies None As Custom Scripts descriptions today are only plain text I can't see the addition of markdown rendering doing any harm.
adam added the status: acceptedtype: feature labels 2025-12-29 19:19:03 +01:00
adam closed this issue 2025-12-29 19:19:03 +01:00
adam commented 2025-12-29 19:19:04 +01:00
Author
Owner
Copy Link

@rodvand commented on GitHub (Mar 11, 2021):

@jeremystretch If I want to handle this (since you've labeled it "needs owner"), do you have to assign it to me or can I just create a PR?

@rodvand commented on GitHub (Mar 11, 2021): @jeremystretch If I want to handle this (since you've labeled it "needs owner"), do you have to assign it to me or can I just create a PR?
adam commented 2025-12-29 19:19:04 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 11, 2021):

You're all set!

@jeremystretch commented on GitHub (Mar 11, 2021): You're all set!
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#4644
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?