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

Closes 10759: Enable markdown support for custom field descriptions #12344

Merged

Conversation

decoupca
Copy link
Contributor

@decoupca decoupca commented Apr 25, 2023

Fixes: #10759

Enables markdown support for:

  • Custom field descriptions
  • Custom validator error messages

@decoupca decoupca changed the title Closes 10759: Enhanced markdown support Closes 10759: Enable markdown support for custom field descriptions and error messages Apr 25, 2023
@jeremystretch
Copy link
Member

I agree with supporting Markdown rendering for custom field descriptions, but I see no need to implement it for form errors: These values are not user-configurable. (It would need to be a separate FR anyway, as the change would impact far more than just custom fields.)

@decoupca
Copy link
Contributor Author

@jeremystretch

I agree with supporting Markdown rendering for custom field descriptions, but I see no need to implement it for form errors: These values are not user-configurable. (It would need to be a separate FR anyway, as the change would impact far more than just custom fields.)

Custom validator error messages are user-configurable, which in my case would benefit from markdown support (linking to internal KBs, etc.) Code in this PR achieves that, which didn't look like it had a large impact. Maybe I missed something?

@jeremystretch
Copy link
Member

There are a lot more places we'd need to apply the Markdown filter for form errors, and some degree of cleanup is needed if we want to head down that path. Let's prune down #10759 to cover just the custom field descriptions so that we can implement that change, then tackle form errors in general under a separate FR.

@decoupca decoupca force-pushed the 10759-markdown-support branch from b9bbc39 to 54df5eb Compare May 2, 2023 14:07
@decoupca decoupca changed the title Closes 10759: Enable markdown support for custom field descriptions and error messages Closes 10759: Enable markdown support for custom field descriptions May 2, 2023
@decoupca
Copy link
Contributor Author

decoupca commented May 2, 2023

@jeremystretch copy that, reverted changes.

@jeremystretch jeremystretch merged commit b14a514 into netbox-community:develop May 2, 2023
@jeremystretch
Copy link
Member

Thanks @decoupca!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable markdown in custom field description fields and custom validator error messages
3 participants