Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow to use markdown on report description #6527

Closed
maximumG opened this issue Jun 2, 2021 · 1 comment · Fixed by #6537
Closed

Allow to use markdown on report description #6527

maximumG opened this issue Jun 2, 2021 · 1 comment · Fixed by #6537
Assignees
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application

Comments

@maximumG
Copy link
Contributor

maximumG commented Jun 2, 2021

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

<td>{{ report.description|placeholder }}</td>

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

@maximumG maximumG added the type: feature Introduction of new functionality to the application label Jun 2, 2021
@jeremystretch jeremystretch added the status: accepted This issue has been accepted for implementation label Jun 2, 2021
@jeremystretch
Copy link
Member

I can handle this issue and propose a Pull Request.

@maximumG have at it!

jeremystretch added a commit that referenced this issue Jun 3, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: accepted This issue has been accepted for implementation type: feature Introduction of new functionality to the application
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants