Commit ed180cea authored by Evan Read's avatar Evan Read

Merge branch 'msj-req-man-enhance-docs' into 'master'

Requirements docs editing and screenshots

See merge request gitlab-org/gitlab!33761
parents 48bc705f 52e93be2
......@@ -22,7 +22,7 @@ When a feature is no longer necessary, you can [archive the related requirement]
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For an overview, see [GitLab 12.10 Introduces Requirements Management](https://www.youtube.com/watch?v=uSS7oUNSEoU).
![requirements list view](img/requirements_list_view_v12_10.png)
![requirements list view](img/requirements_list_v13_1.png)
## Create a requirement
......@@ -38,8 +38,6 @@ To create a requirement:
You will see the newly created requirement on the top of the list, as the requirements
list is sorted by creation date in descending order.
![requirement create view](img/requirement_create_view_v12_10.png)
## Edit a requirement
You can edit a requirement (if you have the necessary privileges) from the requirements
......@@ -51,16 +49,12 @@ To edit a requirement:
1. Update the title in text input field.
1. Click **Save changes**.
![requirement edit view](img/requirement_edit_view_v12_10.png)
## Archive a requirement
You can archive an open requirement (if you have the necessary privileges) while
you're in the **Open** tab.
From the requirements list page, click **Archive** (**{archive}**).
![requirement archive view](img/requirement_archive_view_v12_10.png)
To archive a requirement, click **Archive** (**{archive}**).
As soon as a requirement is archived, it no longer appears in the **Open** tab.
......@@ -68,28 +62,29 @@ As soon as a requirement is archived, it no longer appears in the **Open** tab.
You can view the list of archived requirements in the **Archived** tab.
![archived requirements list](img/requirements_archived_list_view_v12_10.png)
![archived requirements list](img/requirements_archived_list_view_v13_1.png)
To reopen an archived requirement, click **Reopen**.
As soon as a requirement is reopened, it no longer appears in the **Archived** tab.
## Search for a requirement from the requirements list page
## Search for a requirement
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212543) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1.
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212543) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1.
You can search for a requirement from the requirements list page based on the following criteria:
You can search for a requirement from the list of requirements using filtered search bar (similar to
that of Issues and Merge Requests) based on following parameters:
- Requirement title
- Author's username
- Title
- Author username
To search for a requirement:
To search, go to the list of requirements and click the field **Search or filter results**.
It will display a dropdown menu, from which you can add an author. You can also enter plain
text to search by epic title or description. When done, press <kbd>Enter</kbd> on your
keyboard to filter the list.
1. In a project, go to **{requirements}** **Requirements > List**.
1. Click the **Search or filter results** field. A dropdown menu appears.
1. Select the requirement author from the dropdown or enter plain text to search by requirement title.
1. Press <kbd>Enter</kbd> on your keyboard to filter the list.
You can also sort requirements list by:
You can also sort the requirements list by:
- Created date
- Last updated
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment