Skip to content

Document Content Editor component and Wiki integration

What does this MR do?

This MR introduces a new documentation page for the Content Editor component. It provides architectural remarks, references to the technologies used to develop the Content Editor, initial usage guidelines, and the status of GFM support.

NOTE: This MR doesn’t intend to be a thorough reference to the Content Editor. The Content Editor is in an early stage of development and its API is subject to change. That’s the reason we aren‘t including documentation about extending the Editor yet. This documentation will evolve and grow in the upcoming milestones. I tried to convey this reality in the document as well.

Related issues

#322498 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Enrique Alcántara

Merge request reports

Loading