Commit fb1f1e48 authored by Craig Norris's avatar Craig Norris

Merge branch 'msj-req-man-note' into 'master'

Fix formatting in Requirements Management doc

See merge request gitlab-org/gitlab!45412
parents 7bad3935 f6b28c31
...@@ -7,7 +7,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -7,7 +7,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Requirements Management **(ULTIMATE)** # Requirements Management **(ULTIMATE)**
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2703) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.10. > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2703) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.10.
> - The ability to add and edit a requirement's long description [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/224622) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.5.
With requirements, you can set criteria to check your products against. They can be based on users, With requirements, you can set criteria to check your products against. They can be based on users,
stakeholders, system, software, or anything else you find important to capture. stakeholders, system, software, or anything else you find important to capture.
...@@ -22,7 +23,7 @@ When a feature is no longer necessary, you can [archive the related requirement] ...@@ -22,7 +23,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> <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). For an overview, see [GitLab 12.10 Introduces Requirements Management](https://www.youtube.com/watch?v=uSS7oUNSEoU).
![requirements list view](img/requirements_list_v13_1.png) ![requirements list view](img/requirements_list_v13_5.png)
## Create a requirement ## Create a requirement
...@@ -32,31 +33,43 @@ can create a new requirement. ...@@ -32,31 +33,43 @@ can create a new requirement.
To create a requirement: To create a requirement:
1. From your project page, go to **{requirements}** **Requirements**. 1. From your project page, go to **{requirements}** **Requirements**.
1. Click **New requirement**. 1. Select **New requirement**.
1. Enter a descriptive title and click **Create requirement**. 1. Enter a title and description and select **Create requirement**.
You will see the newly created requirement on the top of the list, as the requirements ![requirement create view](img/requirement_create_v13_5.png)
list is sorted by creation date in descending order.
You can see the newly created requirement on the top of the list, with the requirements
list being sorted by creation date, in descending order.
## View a requirement
You can view a requirement from the list by selecting it.
![requirement view](img/requirement_view_v13_5.png)
To edit a requirement while viewing it, select the **Edit** icon (**{pencil}**)
next to the requirement title.
## Edit a requirement ## Edit a requirement
> - [Added](https://gitlab.com/gitlab-org/gitlab/-/issues/218607) ability to mark a requirement as Satisfied in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.5. > The ability to mark a requirement as Satisfied [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218607) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.5.
You can edit a requirement (if you have the necessary privileges) from the requirements You can edit a requirement (if you have the necessary privileges) from the requirements
list page. list page.
To edit a requirement: To edit a requirement:
1. From the requirements list, click **Edit** (**{pencil}**). 1. From the requirements list, select the **Edit** icon (**{pencil}**).
1. Update the title in text input field. You can also mark a requirement as satisfied in the edit form by using the checkbox labeled "Satisfied". 1. Update the title and description in text input field. You can also mark a
1. Click **Save changes**. requirement as satisfied in the edit form by using the check box **Satisfied**.
1. Select **Save changes**.
## Archive a requirement ## Archive a requirement
You can archive an open requirement (if you have the necessary privileges) while You can archive an open requirement (if you have the necessary privileges) while
you're in the **Open** tab. you're in the **Open** tab.
To archive a requirement, click **Archive** (**{archive}**). To archive a requirement, select **Archive** (**{archive}**).
As soon as a requirement is archived, it no longer appears in the **Open** tab. As soon as a requirement is archived, it no longer appears in the **Open** tab.
...@@ -66,7 +79,7 @@ You can view the list of archived requirements in the **Archived** tab. ...@@ -66,7 +79,7 @@ You can view the list of archived requirements in the **Archived** tab.
![archived requirements list](img/requirements_archived_list_view_v13_1.png) ![archived requirements list](img/requirements_archived_list_view_v13_1.png)
To reopen an archived requirement, click **Reopen**. To reopen an archived requirement, select **Reopen**.
As soon as a requirement is reopened, it no longer appears in the **Archived** tab. As soon as a requirement is reopened, it no longer appears in the **Archived** tab.
...@@ -82,7 +95,7 @@ You can search for a requirement from the requirements list page based on the fo ...@@ -82,7 +95,7 @@ You can search for a requirement from the requirements list page based on the fo
To search for a requirement: To search for a requirement:
1. In a project, go to **{requirements}** **Requirements > 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 **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. 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. 1. Press <kbd>Enter</kbd> on your keyboard to filter the list.
......
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