Skip to content

Commit 6f4e818

Browse files
sarahsanders-dockergloursestebanx64vvolandnicks
authored
publish updates from main (#22917)
Automated pull request for publishing docs updates. --------- Signed-off-by: Paweł Gronowski <[email protected]> Signed-off-by: Craig <[email protected]> Co-authored-by: Guillaume Lours <[email protected]> Co-authored-by: Esteban Maya <[email protected]> Co-authored-by: Sarah Sanders <[email protected]> Co-authored-by: Paweł Gronowski <[email protected]> Co-authored-by: Nick Santos <[email protected]> Co-authored-by: Arthur <[email protected]> Co-authored-by: Craig Osterhout <[email protected]> Co-authored-by: Allie Sadler <[email protected]>
2 parents 90929ee + 0e39ab8 commit 6f4e818

File tree

71 files changed

+775
-866
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+775
-866
lines changed

_vale/Docker/Acronyms.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ exceptions:
146146
- TTY
147147
- TXT
148148
- UDP
149+
- UI
149150
- URI
150151
- URL
151152
- USB

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ rootful
133133
runc
134134
Ryuk
135135
S3
136+
scrollable
136137
Slack
137138
snapshotters?
138139
Snyk

content/contribute/ui.md

Lines changed: 53 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,73 @@
11
---
22
title: UI elements in content
3-
description: How to refer and interact with UI content
4-
keywords: ui, contribute, style guide
3+
description: How to refer to and write about UI elements in technical documentation.
4+
keywords: ui, contribute, style guide, docker docs
55
weight: 40
66
---
77

8-
This page contains information on how to write technical content that involves a user interface (UI).
8+
Use this guide when writing documentation that refers to buttons, fields, menus, dialogs, or other user interface (UI) elements. It explains how to format UI terms, write task-focused instructions, and refer to common UI patterns consistently and clearly.
99

10-
## Format names of UI elements
10+
## Format UI element names
1111

12-
Always bold UI elements when referring to them by name.
12+
Use bold formatting for the visible names of UI elements:
1313

14-
This includes names for buttons, menus, dialogs, windows, list items, or any other feature on the page that has a visible name.
14+
- Buttons
15+
- Dialogs
16+
- Windows
17+
- Tabs
18+
- Menu items
19+
- List items
20+
- Form labels
21+
- Section headings
1522

16-
Don't make an official feature name or product name bold, except when it directly refers to an element on the page that uses the name, such as a window title or button name.
23+
For example:
1724

18-
In most cases, follow the capitalization as it appears on the page. However, if labels are inconsistent or they're all uppercase, use sentence case.
25+
*Select **Create**, then fill out the **Name** field.*
1926

20-
## Focus on the task
27+
Do not bold product names or features unless they appear exactly as a label in the UI.
2128

22-
When practical, state instructions in terms of what the user should accomplish, rather than focusing on the widgets and gestures. By avoiding reference to UI elements, you help the user understand the purpose of an instruction, and it can help future-proof procedures.
29+
### Capitalization
2330

24-
|Correct |Incorrect |
25-
|:-----------|:------------|
26-
|Expand the **Advanced options** section | Select the zippy to expand the **Advanced options** section|
31+
- Follow the capitalization as it appears in the UI.
32+
- If UI labels are all uppercase or inconsistent, use sentence case in your docs for readability.
2733

34+
## Write task-focused instructions
2835

29-
## Refer to UI elements
36+
When possible, guide users based on what they’re trying to do, not just what they should select. This makes docs more goal-oriented and adaptable to UI changes.
3037

31-
Don't use UI elements as if they were English verbs or nouns.
38+
| Do this | Avoid this |
39+
|----------------------------------|-------------------------------------------|
40+
| Expand the **Advanced options** section. | Select the zippy to expand the **Advanced options** section. |
41+
| Choose a base image for your container. | Select a dropdown and pick something. |
3242

33-
|Correct |Incorrect |
34-
|:-----------|:------------|
35-
|In the **Name** field, enter an account name. | **Name** the account.|
36-
|To save the settings, select **Save**.| **Save** the settings.|
3743

38-
## Prepositions
44+
## Use correct prepositions with UI elements
3945

40-
When documenting the UI, use the following prepositions.
46+
Choose the right preposition based on the type of UI element you're referencing.
4147

42-
|Preposition |UI element | Example |
43-
|:-----------|:------------|:-----------|
44-
|in | dialogs <br>fields <br>lists <br>menus <br>panes <br>windows <br>| In the **Alert** dialog, select **OK**. <br> In the **Name** field, enter `wsfc-1`. <br> In the **Item** list, select **Desktop**. <br>In the **File** menu, click **Tools**.<br> In the **Metrics** pane, select **New**. <br>In the **Task** window, select **Start**. |
45-
| on |pages <br>tabs <br>toolbars | On the **Create an instance** page, select **Add**. <br> On the **Edit** tab, select **Save**.<br> On the **Dashboard toolbar**, select **Edit**.<br>|
48+
| Preposition | Use with... | Example |
49+
|-------------|--------------------------------|---------|
50+
| **in** | dialogs, fields, lists, menus, panes, windows | In the **Name** field, enter your project name. |
51+
| **on** | pages, tabs, toolbars | On the **Settings** tab, select **General**. |
52+
53+
54+
## Use consistent UI element terms
55+
56+
Use these standard terms when referring to elements in Docker products:
57+
58+
| Preferred Term | Use When Referring To... |
59+
|---------------------|----------------------------------------------|
60+
| **button** | A clickable action element (e.g., **Start**) |
61+
| **field** | A place to enter text or select a value |
62+
| **menu** / **menu item** | A drop-down or navigation option |
63+
| **drop-down** | A drop-down menu item |
64+
| **context switcher** | Specific to toggling on cloud mode |
65+
| **tab** | A selectable view within a window or page |
66+
| **dialog** | A popup window for confirmations or options |
67+
| **section** | A logical grouping of content on a page |
68+
| **list** / **list item** | A scrollable list of selectable entries |
69+
| **toggle** | A binary control (on/off) |
70+
| **checkbox** | A multi-select control |
71+
| **tooltip** | Text that appears on hover |
72+
73+
Finally, instead of saying “click the control,” say “select the **Create** button.”

content/manuals/accounts/deactivate-user-account.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ Before deactivating your Docker account, ensure you meet the following requireme
1717

1818
- For owners, you must leave your organization or company before deactivating your Docker account.
1919
To do this:
20-
1. Sign in to the [Docker Admin Console](https://app.docker.com/admin).
21-
2. Select the organization you need to leave from the **Choose profile** page.
22-
3. Find your username in the **Members** tab.
23-
4. Select the **More options** menu and then select **Leave organization**.
20+
1. Sign in to [Docker Home](https://app.docker.com/admin) and choose
21+
your organization.
22+
1. Select **Admin Console**.
23+
1. Select **Members** and find your username.
24+
1. Select the **Actions** menu and then select **Leave organization**.
2425

2526
- If you are the sole owner of an organization, you must assign the owner role to another member of the organization and then remove yourself from the organization, or deactivate the organization. Similarly, if you are the sole owner of a company, either add someone else as a company owner and then remove yourself, or deactivate the company.
2627

@@ -39,8 +40,8 @@ Once you have completed all the previous steps, you can deactivate your account.
3940
> This cannot be undone. Be sure you've gathered all the data you need from your account before deactivating it.
4041
4142
1. Sign in to [Docker Home](https://app.docker.com/login).
42-
2. Select your avatar to open the drop-down menu.
43-
3. Select **Account settings**.
44-
4. Select **Deactivate**.
45-
5. Select **Deactivate account**.
46-
6. To confirm, select **Deactivate account**.
43+
1. Select your avatar to open the drop-down menu.
44+
1. Select **Account settings**.
45+
1. Select **Deactivate**.
46+
1. Select **Deactivate account**.
47+
1. To confirm, select **Deactivate account**.

content/manuals/accounts/manage-account.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ account security.
1818
## Update general settings
1919

2020
1. Sign in to your [Docker account](https://app.docker.com/login).
21-
2. In Docker Home, select your avatar in the top-right corner to open the
22-
drop-down.
23-
3. Select **Account settings**.
21+
2. Select your avatar in the top-right corner and select **Account settings**.
2422

2523
From the Account settings page, you can take any of the following actions.
2624

content/manuals/admin/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ aliases:
3737

3838
Administrators can manage companies and organizations using the Docker Admin Console.
3939

40-
The [Docker Admin Console](https://admin.docker.com) provides administrators with centralized observability, access management, and controls for their company and organizations. To provide these features, Docker uses the following hierarchy and roles.
40+
The [Docker Admin Console](https://app.docker.com/admin) provides administrators with centralized observability, access management, and controls for their company and organizations. To provide these features, Docker uses the following hierarchy and roles.
4141

4242
![Docker hierarchy](./images/docker-admin-structure.webp)
4343

content/manuals/admin/company/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ grid:
3333
- title: Domain management
3434
description: Add and verify your domains.
3535
icon: domain_verification
36-
link: /admin/company/settings/domains/
36+
link: /security/for-admins/domain-management/
3737
- title: FAQs
3838
description: Explore common company FAQs.
3939
link: /faq/admin/company-faqs/

content/manuals/admin/company/new-company.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ You can create a new company in the Docker Admin Console. Before you begin, you
1616

1717
To create a new company:
1818

19-
1. Sign in to the [Admin Console](https://app.docker.com/admin).
20-
2. Select your organization you want to add to your company from the **Choose profile** page.
21-
3. Under **Organization settings**, select **Company management**.
22-
4. Select **Create a company**.
23-
5. Enter a unique name for your company, then select **Continue**.
19+
1. Sign in to [Docker Home](https://app.docker.com/) and select your
20+
organization.
21+
1. Select **Admin Console**, then **Company management**.
22+
1. Select **Create a company**.
23+
1. Enter a unique name for your company, then select **Continue**.
2424

2525
> [!TIP]
2626
>
2727
> The name for your company can't be the same as an existing user, organization, or company namespace.
2828
29-
6. Review the company migration details and then select **Create company**.
29+
1. Review the company migration details and then select **Create company**.
3030

3131
For more information on how you can add organizations to your company, see [Add organizations to a company](./organizations.md#add-organizations-to-a-company).
3232

content/manuals/admin/company/organizations.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ You can manage the organizations in a company in the Docker Admin Console.
1010

1111
## View all organizations
1212

13-
1. Sign in to the [Admin Console](https://admin.docker.com).
14-
2. Select your company on the **Choose profile** page.
15-
3. Under **Organizations**, select **Overview**.
13+
1. Sign in to the [Docker Home](https://app.docker.com) and choose
14+
your company.
15+
1. Select **Admin Console**, then **Organizations**.
1616

17-
The organization overview page displays all organizations under your company.
17+
The **Organizations** view displays all organizations under your company.
1818

1919
## Add seats to an organization
2020

@@ -30,18 +30,17 @@ You must be a company owner to add an organization to a company. You must also b
3030
>
3131
> Once you add an organization to a company, you can't remove it from the company.
3232
33-
1. Sign in to the [Admin Console](https://admin.docker.com).
34-
2. Select your company on the **Choose profile** page.
35-
3. Select **Organizations**, then **Overview**.
36-
4. Select **Add organization**.
37-
5. Choose the organization you want to add from the drop-down menu.
38-
6. Select **Add organization** to confirm.
33+
1. Sign in to [Docker Home](https://app.docker.com) and select your company.
34+
1. Select **Admin Console**, then **Organizations**.
35+
1. Select **Add organization**.
36+
1. Choose the organization you want to add from the drop-down menu.
37+
1. Select **Add organization** to confirm.
3938

4039
## Manage an organization
4140

42-
1. Sign in to the [Admin Console](https://admin.docker.com).
43-
2. Select your company on the **Choose profile** page.
44-
3. Select the organization that you want to manage.
41+
1. Sign in to [Docker Home](https://app.docker.com) and select your company.
42+
1. Select **Admin Console**, then **Organizations**.
43+
1. Select the organization you want to manage.
4544

4645
For more details about managing an organization, see [Organization administration](../organization/_index.md).
4746

content/manuals/admin/company/owners.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,15 @@ owners don't need to be member of an organization.
2323
2424
## Add a company owner
2525

26-
1. Sign in to the [Admin Console](https://admin.docker.com).
27-
2. Select your company on the **Choose profile** page.
28-
3. Select **Company owners**.
29-
4. Select **Add owner**.
30-
5. Specify the user's Docker ID to search for the user.
31-
6. After you find the user, select **Add company owner**.
26+
1. Sign in to [Docker Home](https://app.docker.com) and select your company.
27+
1. Select **Admin Console**, then **Company owners**.
28+
1. Select **Add owner**.
29+
1. Specify the user's Docker ID to search for the user.
30+
1. After you find the user, select **Add company owner**.
3231

3332
## Remove a company owner
3433

35-
1. Sign in to the [Admin Console](https://admin.docker.com).
36-
2. Select your company on the **Choose profile** page.
37-
3. Select **Company owners**.
38-
4. Select the **Action** icon in the row of the company owner that your want to remove.
39-
5. Select **Remove as company owner**.
34+
1. Sign in to [Docker Home](https://app.docker.com) and select your company.
35+
1. Select **Admin Console**, then **Company owners**.
36+
1. Locate the company owner you want to remove and select the **Actions** menu.
37+
1. Select **Remove as company owner**.

0 commit comments

Comments
 (0)