Support Markdown in dashboard descriptions.

toolness commented 3 years ago

This fixes #115 by supporting Markdown in dashboard descriptions. It also mentions that Markdown is allowed in all user-facing views.

Notes

I thought it would help to mention that Markdown is allowed in the Django-admin view, so I added help_text to the description model field, e.g.:

However, this required adding a new database migration, which is annoying because it doesn't actually change the database schema. If you're loath to do this, I could try "hacking" the help_text into an earlier migration, since it doesn't make a difference in practice.
I couldn't see any kind of changelog, so I wasn't sure where to mention that this is technically a breaking change.

toolness commented 3 years ago

Note that I just formatted the code using Black 21.5b1, but I'm not sure if it formats code differently from whatever version of Black you're using... I filed #119 to deal with this separately.

simonw commented 3 years ago

I'm fine with the migration.

The release log for this project currently just lives at https://github.com/simonw/django-sql-dashboard/releases - though maybe it should move into the docs folder now?

I'll be sure to mention this as a potentially breaking change when I write the release notes there.

simonw / django-sql-dashboard

Support Markdown in dashboard descriptions. #118

Notes