Skip to content

Requirements docs editing and screenshots

Marcin Sedlak-Jakubowski requested to merge msj-req-man-enhance-docs into master

What does this MR do?

  • Add better screenshots - using an example app and not lorem ipsum
  • Edit the "Sort requirements" section added in !31857 (merged): format the "introduced in" note to follow the style guide

Review App: http://docs-preview-ee-33761.178.62.207.141.nip.io/ee/user/project/requirements/index.html

Follow-up

Add a use case section and describe an example app.

Related issues

#212889 (closed)

Author's checklist (required)

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

  • Optional: 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.

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 🤖 GitLab Bot 🤖

Merge request reports