Commit 1b1f1da7 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'msj-style-guide-examples' into 'master'

Add docs style guideline for the right sidebar

See merge request gitlab-org/gitlab!75358
parents 0acb6ca8 84105c23
...@@ -1053,7 +1053,9 @@ Guidance for each individual UI element is in [the word list](word_list.md). ...@@ -1053,7 +1053,9 @@ Guidance for each individual UI element is in [the word list](word_list.md).
### How to write navigation task steps ### How to write navigation task steps
To be consistent, use this format when you write navigation steps in a task topic. To be consistent, use these templates when you write navigation steps in a task topic.
To open project settings:
```markdown ```markdown
1. On the top bar, select **Menu > Projects** and find your project. 1. On the top bar, select **Menu > Projects** and find your project.
...@@ -1061,7 +1063,7 @@ To be consistent, use this format when you write navigation steps in a task topi ...@@ -1061,7 +1063,7 @@ To be consistent, use this format when you write navigation steps in a task topi
1. Expand **General pipelines**. 1. Expand **General pipelines**.
``` ```
Another example: To open group settings:
```markdown ```markdown
1. On the top bar, select **Menu > Groups** and find your group. 1. On the top bar, select **Menu > Groups** and find your group.
...@@ -1069,7 +1071,7 @@ Another example: ...@@ -1069,7 +1071,7 @@ Another example:
1. Expand **General pipelines**. 1. Expand **General pipelines**.
``` ```
An Admin Area example: To open the Admin Area:
```markdown ```markdown
1. On the top bar, select **Menu > Admin**. 1. On the top bar, select **Menu > Admin**.
...@@ -1081,6 +1083,15 @@ To select your avatar: ...@@ -1081,6 +1083,15 @@ To select your avatar:
1. On the top bar, in the top right corner, select your avatar. 1. On the top bar, in the top right corner, select your avatar.
``` ```
To save the selection in some dropdown lists:
```markdown
1. Go to your issue.
1. On the right sidebar, in the **Iteration** section, select **Edit**.
1. From the dropdown list, select the iteration to associate this issue with.
1. Select any area outside the dropdown list.
```
### Optional steps ### Optional steps
If a step is optional, start the step with the word `Optional` followed by a period. If a step is optional, start the step with the word `Optional` followed by a period.
......
...@@ -165,7 +165,7 @@ To group issues by label: ...@@ -165,7 +165,7 @@ To group issues by label:
1. Select the **Filter by label** dropdown. 1. Select the **Filter by label** dropdown.
1. Select the labels you want to group by in the labels dropdown. 1. Select the labels you want to group by in the labels dropdown.
You can also search for labels by typing in the search input. You can also search for labels by typing in the search input.
1. Select or tap outside of the label dropdown. The page is now grouped by the selected labels. 1. Select any area outside the label dropdown list. The page is now grouped by the selected labels.
### Enable or disable iteration cadences **(PREMIUM SELF)** ### Enable or disable iteration cadences **(PREMIUM SELF)**
......
...@@ -393,7 +393,7 @@ To add an issue to an [iteration](../../group/iterations/index.md): ...@@ -393,7 +393,7 @@ To add an issue to an [iteration](../../group/iterations/index.md):
1. Go to your issue. 1. Go to your issue.
1. On the right sidebar, in the **Iteration** section, select **Edit**. 1. On the right sidebar, in the **Iteration** section, select **Edit**.
1. From the dropdown list, select the iteration to associate this issue with. 1. From the dropdown list, select the iteration to associate this issue with.
1. Click or tap anywhere outside of the dropdown. 1. Select any area outside the dropdown list.
You can also use the `/iteration` You can also use the `/iteration`
[quick action](../quick_actions.md#issues-merge-requests-and-epics) [quick action](../quick_actions.md#issues-merge-requests-and-epics)
...@@ -457,7 +457,7 @@ To change the assignee on an issue: ...@@ -457,7 +457,7 @@ To change the assignee on an issue:
1. Go to your issue. 1. Go to your issue.
1. On the right sidebar, in the **Assignee** section, select **Edit**. 1. On the right sidebar, in the **Assignee** section, select **Edit**.
1. From the dropdown list, select the user to add as an assignee. 1. From the dropdown list, select the user to add as an assignee.
1. Click or tap anywhere outside of the dropdown list. 1. Select any area outside the dropdown list.
## Similar issues ## Similar issues
......
...@@ -42,8 +42,8 @@ To assign or unassign a label: ...@@ -42,8 +42,8 @@ To assign or unassign a label:
You can search repeatedly to add more labels. You can search repeatedly to add more labels.
The selected labels are marked with a checkmark. The selected labels are marked with a checkmark.
1. Click the labels you want to assign or unassign. 1. Click the labels you want to assign or unassign.
1. To apply your changes to labels, click **X** next to **Assign labels** or anywhere outside the 1. To apply your changes to labels, select **X** next to **Assign labels** or select any area
label section. outside the label section.
Alternatively, to unassign a label, click the **X** on the label you want to unassign. Alternatively, to unassign a label, click the **X** on the label you want to unassign.
......
...@@ -456,7 +456,7 @@ when: ...@@ -456,7 +456,7 @@ when:
- <kbd>Control</kbd> + <kbd>S</kbd> (or <kbd>Command</kbd> + <kbd>S</kbd> on Mac) - <kbd>Control</kbd> + <kbd>S</kbd> (or <kbd>Command</kbd> + <kbd>S</kbd> on Mac)
is pressed while editing a file. is pressed while editing a file.
- Anything outside the file editor is clicked after editing a file. - You select any area outside the file editor after editing a file.
- A file or folder is created, deleted, or renamed. - A file or folder is created, deleted, or renamed.
### Limitations ### Limitations
......
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