Skip to content

Instrument keyboard shortcuts and input rules in the Content Editor

What does this MR do?

This change is behind a feature flag. It instruments the execution of keyboard shortcuts and input rules in the Content Editor.

How to test?

  • Enable the :wiki_content_editor feature flag.
  • Edit a wiki page and click the use new editor button. Screen_Shot_2021-05-15_at_9.16.04_AM
  • Creating a heading using an input rule. An input rule uses Markdown syntax to create an element in the Content Editor. Type ## Heading and a lvl 2 heading will be created: 2021-05-16_08.13.50
  • Create a second heading using the keyboard shortcut Cmd Alt 2.
  • You should see two structured events with the following information
Input rule Keyboard shortcut
Screen_Shot_2021-05-16_at_8.20.46_AM Screen_Shot_2021-05-16_at_8.21.07_AM

Relevant documentation

I recommend reading these sections of Tiptap and ProseMirror’s documentation to understand the APIs used by this MR:

Screenshots (strongly suggested)

[No user-facing changes]

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team

Related to #329650 (closed)

Edited by Enrique Alcántara

Merge request reports