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

Allow to use markdown on report description #4959

New Issue
Closed
opened 2025-12-29 19:22:38 +01:00 by adam · 1 comment
adam commented 2025-12-29 19:22:38 +01:00
Owner
Copy Link

Originally created by @maximumG on GitHub (Jun 2, 2021).

Originally assigned to: @maximumG on GitHub.

NetBox version

v2.11.3

Feature type

Change to existing functionality

Proposed functionality

I'd like to propose an enhancement on the look & feel of the report_list.html page.

Each report is currently presented in a List of 4 columns (Name | Status | Description | Last Run). I would propose to render the Description column using markdown support.

The change would be as simple as modifying the report_list.html template and add the class rendered-markdown and use the markdown django template function on the following line

8d0a3c8e69/netbox/templates/extras/report_list.html (L32)

The markdown support has already been implemented for each report log messages so it won't be difficult to use the same feature for the Report description (check this commit)

I can handle this issue and propose a Pull Request.

Use case

Adding markdown support to each Report description allows to structure the this description easily if we want to explain in more detail the whole test case covered.

Database changes

None

External dependencies

None

Originally created by @maximumG on GitHub (Jun 2, 2021). Originally assigned to: @maximumG on GitHub. ### NetBox version v2.11.3 ### Feature type Change to existing functionality ### Proposed functionality I'd like to propose an enhancement on the look & feel of the r[eport_list.html](https://github.com/netbox-community/netbox/blob/develop/netbox/templates/extras/report_list.html) page. Each report is currently presented in a List of 4 columns (_Name_ | _Status_ | _Description_ | _Last Run_). I would propose to render the _Description_ column using markdown support. The change would be as simple as modifying the report_list.html template and add the class `rendered-markdown` and use the `markdown` django template function on the following line https://github.com/netbox-community/netbox/blob/8d0a3c8e6932f4c523919180d3e75608cdf54a9b/netbox/templates/extras/report_list.html#L32 The markdown support has already been implemented for each report log messages so it won't be difficult to use the same feature for the Report description (check this [commit](https://github.com/netbox-community/netbox/commit/7c48e3632db052924c80213fc07faa8d3059fe7c)) I can handle this issue and propose a Pull Request. ### Use case Adding markdown support to each Report description allows to structure the this description easily if we want to explain in more detail the whole test case covered. ### Database changes None ### External dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 19:22:38 +01:00
adam closed this issue 2025-12-29 19:22:39 +01:00
adam commented 2025-12-29 19:22:39 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 2, 2021):

I can handle this issue and propose a Pull Request.

@maximumG have at it!

@jeremystretch commented on GitHub (Jun 2, 2021): > I can handle this issue and propose a Pull Request. @maximumG have at it!
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#4959
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?