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 a "readme" field supporting markdown in custom scripts #4056

New Issue
Closed
opened 2025-12-29 18:32:52 +01:00 by adam · 5 comments
adam commented 2025-12-29 18:32:52 +01:00
Owner
Copy Link

Originally created by @Tavoons on GitHub (Sep 1, 2020).

Environment

  • Python version: 3.7.9
  • NetBox version: 2.9.2

Proposed Functionality

Add Markdown support to describe scripts.
It will allows devs to display more details on their scripts.

Description can stay a short description field and you can add a "readme" field supporting markdown in Meta

Use Case

I'm working with big scripts doing a lot of things.
I would like to display a description of what the script does directly in the Custom Script page
image

Database Changes

No changes for database

External Dependencies

There is already markdown support (for log_success, log_warning, etc) so it wouldn't add others dependencies

Originally created by @Tavoons on GitHub (Sep 1, 2020). ### Environment * Python version: 3.7.9 * NetBox version: 2.9.2 ### Proposed Functionality Add Markdown support to describe scripts. It will allows devs to display more details on their scripts. Description can stay a short description field and you can add a "readme" field supporting markdown in Meta ### Use Case I'm working with big scripts doing a lot of things. I would like to display a description of what the script does directly in the Custom Script page ![image](https://user-images.githubusercontent.com/39608697/91850709-43651380-ec5e-11ea-9bdf-c77bdadc54ff.png) ### Database Changes No changes for database ### External Dependencies There is already markdown support (for log_success, log_warning, etc) so it wouldn't add others dependencies
adam added the type: featurepending closure labels 2025-12-29 18:32:52 +01:00
adam closed this issue 2025-12-29 18:32:52 +01:00
adam commented 2025-12-29 18:32:53 +01:00
Author
Owner
Copy Link

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

This issue conflates two different proposals:

Add markdown support for description field

add a "readme" field supporting markdown in Meta

Please update your title and/or post above to clarify which is being proposed.

@jeremystretch commented on GitHub (Sep 1, 2020): This issue conflates two different proposals: > Add markdown support for description field > add a "readme" field supporting markdown in Meta Please update your title and/or post above to clarify which is being proposed.
adam commented 2025-12-29 18:32:53 +01:00
Author
Owner
Copy Link

@Tavoons commented on GitHub (Sep 1, 2020):

Hi Jeremy,
As you said, i'm not really clear !
I don't want to disturb other people's scripts. So adding a new field is better :)
But if you think that adding markdown support in description is better, it's ok for me.

@Tavoons commented on GitHub (Sep 1, 2020): Hi Jeremy, As you said, i'm not really clear ! I don't want to disturb other people's scripts. So adding a new field is better :) But if you think that adding markdown support in description is better, it's ok for me.
adam commented 2025-12-29 18:32:53 +01:00
Author
Owner
Copy Link

@barnebyte commented on GitHub (Sep 10, 2020):

Hey @Tavoons , not sure if it's suitable for you, but i encountered the same requirement for one of my huge script and i've made a "workaround" for it by putting the long version of the description to the description of a new BooleanVar at the top of the page, with some "I have read and understand of what this script is doing" label. The description of BooleanVar supports markdown language. I know it's not the same as you were looking for, but for me it was suitable enough, thought i would share.

@barnebyte commented on GitHub (Sep 10, 2020): Hey @Tavoons , not sure if it's suitable for you, but i encountered the same requirement for one of my huge script and i've made a "workaround" for it by putting the long version of the description to the description of a new BooleanVar at the top of the page, with some "I have read and understand of what this script is doing" label. The description of BooleanVar supports markdown language. I know it's not the same as you were looking for, but for me it was suitable enough, thought i would share.
adam commented 2025-12-29 18:32:53 +01:00
Author
Owner
Copy Link

@Tavoons commented on GitHub (Sep 10, 2020):

@barnebyte
Interesting, I'll try that now. It's even better to have a boolean to check :) Thanks for sharing :)

@Tavoons commented on GitHub (Sep 10, 2020): @barnebyte Interesting, I'll try that now. It's even better to have a boolean to check :) Thanks for sharing :)
adam commented 2025-12-29 18:32:53 +01:00
Author
Owner
Copy Link

@stale[bot] commented on GitHub (Sep 30, 2020):

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.

@stale[bot] commented on GitHub (Sep 30, 2020): 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#4056
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?