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.

Sign up for GitHub

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

Jump to bottom

Support markdown and/or HTML in dashboard descriptions #115

Closed
toolness opened this issue May 20, 2021 · 5 comments · Fixed by #118
Closed

Support markdown and/or HTML in dashboard descriptions #115

toolness opened this issue May 20, 2021 · 5 comments · Fixed by #118
Labels
enhancement New feature or request

Comments

@toolness
Copy link
Contributor

In particular, I'm linking out to external sites in my dashboard descriptions, so it would be great to have those hyperlinked (currently the viewer has to manually copy/paste the URL, which is shown as plain text). Since the package already has both markdown and bleach as dependencies, it doesn't seem like this should be technically complex, although perhaps making it backwards-compatible might be non-trivial...

Anyways, happy to discuss this further and start a PR if it's deemed a good idea.
@simonw simonw added the enhancement New feature or request label May 24, 2021
@simonw
Copy link
Owner

simonw commented May 24, 2021

This is a great idea - especially since we already bundle the Markdown library for other purposes.

I think the simplest solution here would be to say that the dashboard description field supports markdown - I don't expect there to be wide enough deployments of the tool that treating existing descriptions as markdown is likely to break anything significant, though we'll still call it out in the release notes.

@toolness
Copy link
Contributor Author

Nice! Would you like me to start a PR for this or any of the other issues? I'm interested in giving back to this codebase but I also understand if you'd rather do things yourself.

@simonw
Copy link
Owner

simonw commented May 25, 2021

Would welcome a PR for this!

@toolness toolness mentioned this issue May 25, 2021
Merged
simonw pushed a commit that referenced this issue Jun 6, 2021
@toolness
Support Markdown in dashboard descriptions
acb3752 
Thanks, @toolness - closes #115
simonw added a commit that referenced this issue Jun 6, 2021
@simonw
Added test for markdown in saved dashboard descriptions, refs #115
c3a73e1
simonw added a commit that referenced this issue Jun 6, 2021
@simonw
Release 0.16
dd1bb18 
Refs #115, #119, #123, #125
@simonw
Copy link
Owner

simonw commented Jun 6, 2021

This is now released as version 0.16. https://github.com/simonw/django-sql-dashboard/releases/tag/0.16

simonw added a commit to simonw/simonwillisonblog that referenced this issue Jun 6, 2021
@simonw
django-sql-dashboard==0.16
7e872de 
Refs simonw/django-sql-dashboard#115
@simonw
Copy link
Owner

simonw commented Jun 6, 2021

Demo: https://simonwillison.net/dashboard/example-dashboard/

@toolness toolness mentioned this issue Jul 7, 2021
Merged
toolness added a commit to JustFixNYC/tenants2 that referenced this issue Jul 7, 2021
@toolness
Upgrade to django-sql-dashboard 1.0.1. (#2140)
8d4a070 
This upgrades us to django-sql-dashboard 1.0.1, which includes a few contributions of my own:

* [The dashboard admin list view links to change views that the user may not have permission to use](simonw/django-sql-dashboard#130)

* [Support markdown and/or HTML in dashboard descriptions](simonw/django-sql-dashboard#115)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Support Markdown in dashboard descriptions. toolness/django-sql-dashboard
2 participants
@simonw @toolness