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

[FEATURE] Add formatting ability for report body fields #1064

Open
14 tasks
chaoticbear opened this issue Apr 12, 2024 · 0 comments
Open
14 tasks

[FEATURE] Add formatting ability for report body fields #1064

chaoticbear opened this issue Apr 12, 2024 · 0 comments

Comments

@chaoticbear
Copy link

chaoticbear commented Apr 12, 2024

Overview

Enable formatting in the report body content fields. This could be as simple as markdown with previews or a full WYSIWYG. I suggest we find an appropriate React editor field component with basic formatting options that outputs Markdown.

This should be easy for people who don't know what Markdown is to use and just click a bold button for example.

Goals

  • Find an appropriate field editor component which ideally outputs MarkDown
  • Should be React based & compatible with our UI component lib (Bootstrap as of now)
  • Disable any features that aren't compatible or aren't reasonable for our use case (images/video until we add that feature)
  • Editor should be use-able by non-devs who don't know what MarkDown is.
  • We may need a separate MarkDown view library for display.
  • Decide how to handle any summary versions of those fields.
  • Implement Editor in report creation screens
  • Implement Editor in report edit screens
  • Implement Editor in incident creation screens
  • Implement Editor in incident edit screens
  • Implement Viewer in report detail screens
  • Implement Viewer in incident detail screens
  • Implement Viewer in report list screens (if needed)
  • Implement Viewer in incident list screens (if needed)

Related Issues

@chaoticbear chaoticbear changed the title [INTERNAL] [FEATURE] Add formatting ability for report body fields Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant