Skip to content

Commit ee04b8a

Browse files
authored
Change spelling of dropdown (#2233)
1 parent 81a0ca8 commit ee04b8a

Some content is hidden

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

52 files changed

+117
-109
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
extends: substitution
22
message: "Consider if '%s' makes sense instead of '%s'."
33
link: 'https://docs.google.com/document/d/1-SAcVPWcZHM1Na88d0_k5HVmc3tRtRHgmrXzKD3uF2I/edit'
4-
level: suggestion
4+
level: error
55
ignorecase: true
66
action:
77
name: replace
88
swap:
99
in the website: on the website
1010
web app: Viam app or Viam platform
11-
cloud app: Viam app or Viam platform
1211
user of an org: member of an org
1312
compute parts: Computer
1413
microprocessor: Raspberry Pi or Jetson or another specific term
1514
main part and child part: main part and sub-part
1615
main part and non-main part: main part and sub-part
1716
subpart: sub-part
18-
on the app: in the app
19-
Scuttlebot: SCUTTLE robot
17+
drop down: dropdown
18+
drop-down: dropdown
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
extends: substitution
2+
message: "Consider if '%s' makes sense instead of '%s'."
3+
link: 'https://docs.google.com/document/d/1-SAcVPWcZHM1Na88d0_k5HVmc3tRtRHgmrXzKD3uF2I/edit'
4+
level: suggestion
5+
ignorecase: true
6+
action:
7+
name: replace
8+
swap:
9+
cloud app: Viam app or Viam platform
10+
Scuttlebot: SCUTTLE robot
11+
on the app: in the app

.github/vale/styles/Viam/But.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
extends: existence
44
message: "Do not start a paragraph with a 'but'."
5-
level: warning
5+
level: error
66
scope: paragraph
77
action:
88
name: remove

.vale.ini

+1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Viam.AvoidSubjunctive = YES
3333
Viam.AvoidSupported = YES
3434
Viam.AvoidWithSubstitution = YES
3535
Viam.AvoidWithSubstitutionViam = YES
36+
Viam.AvoidWithSubstitutionViamSuggestOnly = YES
3637
Viam.AvoidWithSubstitutionViamCaseSensitive = YES
3738
Viam.But = YES
3839
Viam.Careful = YES

docs/components/arm/ur5e.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Click on the **Components** subtab and click **Create component**.
1818
Select the `arm` type, then select the `ur5e` model.
1919
Enter a name for your arm and click **Create**.
2020

21-
![Web UI configuration panel for an arm of model ur5e in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/ur5e-ui-config.png)
21+
![Web UI configuration panel for an arm of model ur5e in the Viam app, with Attributes & Depends On dropdowns and the option to add a frame.](/components/arm/ur5e-ui-config.png)
2222

2323
Edit and fill in the attributes as applicable.
2424

docs/components/arm/xarm6.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Click on the **Components** subtab and click **Create component**.
1919
Select the `arm` type, then select the `xArm6` model.
2020
Enter a name for your arm and click **Create**.
2121

22-
![Web UI configuration panel for an arm of model xArm6 in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/xArm6-ui-config.png)
22+
![Web UI configuration panel for an arm of model xArm6 in the Viam app, with Attributes & Depends On dropdowns and the option to add a frame.](/components/arm/xArm6-ui-config.png)
2323

2424
Edit and fill in the attributes as applicable.
2525

docs/components/arm/xarm7.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Click on the **Components** subtab and click **Create component**.
1919
Select the `arm` type, then select the `xArm7` model.
2020
Enter a name for your arm and click **Create**.
2121

22-
![Web UI configuration panel for an arm of model xArm6 in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/xArm7-ui-config.png)
22+
![Web UI configuration panel for an arm of model xArm6 in the Viam app, with Attributes & Depends On dropdowns and the option to add a frame.](/components/arm/xArm7-ui-config.png)
2323

2424
Edit and fill in the attributes as applicable.
2525

docs/components/arm/xarmlite.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Click on the **Components** subtab and click **Create component**.
1818
Select the `arm` type, then select the `xArmLite` model.
1919
Enter a name for your arm and click **Create**.
2020

21-
![Web UI configuration panel for an arm of model xArmLite in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/xArmLite-ui-config.png)
21+
![Web UI configuration panel for an arm of model xArmLite in the Viam app, with Attributes & Depends On dropdowns and the option to add a frame.](/components/arm/xArmLite-ui-config.png)
2222

2323
Copy and paste the following attribute template into your arm's **Attributes** box.
2424
Then remove and fill in the attributes as applicable to your arm, according to the table below.

docs/components/arm/yahboom-dofbot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Enter a name for your arm and click **Create**.
2424

2525
There are no attributes available for this modular arm.
2626

27-
![Web UI configuration panel for an arm of model yahboom-dofbot in the Viam app, with Attributes & Depends On drop-downs and the option to add a frame.](/components/arm/yahboom-dofbot-ui-config.png)
27+
![Web UI configuration panel for an arm of model yahboom-dofbot in the Viam app, with Attributes & Depends On dropdowns and the option to add a frame.](/components/arm/yahboom-dofbot-ui-config.png)
2828

2929
Edit and fill in the attributes as applicable.
3030

docs/components/base/wheeled.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Click on the **Components** subtab and click **Create component**.
2222
Select the `base` type, then select the `wheeled` model.
2323
Enter a name for your arm and click **Create**.
2424

25-
{{< imgproc src="/components/base/wheeled-base-ui-config.png" alt="An example configuration for a wheeled base in the Viam app config builder, with Attributes & Depends On drop-downs and the option to add a frame." resize="600x" >}}
25+
{{< imgproc src="/components/base/wheeled-base-ui-config.png" alt="An example configuration for a wheeled base in the Viam app config builder, with Attributes & Depends On dropdowns and the option to add a frame." resize="600x" >}}
2626

2727
Select the motors attached to the base as your **Right Motors** and **Left Motors**.
2828
Edit and fill in the attributes as applicable.

docs/components/camera/webcam.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Enter a name for your camera and click **Create**.
2323
{{< imgproc src="/components/camera/configure-webcam.png" alt="Configuration of a webcam camera in the Viam app config builder." resize="600x" >}}
2424

2525
Edit and fill in the attributes as applicable.
26-
If you click on the **Video Path** field while your robot is live, a drop down autopopulates with identified camera paths.
26+
If you click on the **Video Path** field while your robot is live, a dropdown autopopulates with identified camera paths.
2727

2828
{{% /tab %}}
2929
{{% tab name="JSON Template" %}}
@@ -139,7 +139,7 @@ Viam supports the following pixel formats:
139139
- YUY2
140140
- Z16
141141

142-
If your machine is connected to the Viam app, the available pixel formats supported by your camera automatically appear in the **Format** drop down menu, which is visible when you click the **Show more** button.
142+
If your machine is connected to the Viam app, the available pixel formats supported by your camera automatically appear in the **Format** dropdown menu, which is visible when you click the **Show more** button.
143143

144144
## View the camera stream
145145

docs/components/encoder/fake.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ No attributes are available for `fake` encoders.
5454

5555
## Test the encoder
5656

57-
Once your encoder is configured and your robot is connected, go to the [**Control** tab](/manage/fleet/robots/#control) and click on the encoder's drop-down panel.
57+
Once your encoder is configured and your robot is connected, go to the [**Control** tab](/manage/fleet/robots/#control) and click on the encoder's dropdown panel.
5858
The ticks count is displayed.
5959

6060
![Encoder control panel.](/components/encoder/control.png)

docs/components/generic/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ no_list: true
1515
The _generic_ component {{< glossary_tooltip term_id="subtype" text="subtype" >}} enables you to add support for unique types of hardware that do not already have an [appropriate API](/program/apis/#component-apis) defined for them.
1616

1717
For example, when using an [arm component](/components/arm/), it makes sense to use the [arm API](/components/arm/#api), which provides specific functionality an arm component needs, such as moving to position or stopping movement.
18-
But if you want to use an LED display, you need very different functionality that isn't currently exposed in any API.
18+
If you want to use an LED display, you need very different functionality that isn't currently exposed in any API.
1919
Instead, you can use the generic component API to add support for your unique type of hardware, like LED displays, to your machine.
2020

2121
There are no built-in generic component models (other than `fake`).

docs/components/input-controller/gamepad.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ If you have another controller that you want to use to control your robot, feel
7777

7878
## Troubleshooting
7979

80-
- If you are not able to see a drop-down menu with the name of your controller appear in the **Control** tab, try specifying the `dev_file` attribute to match the exact path to your device.
80+
- If you are not able to see a dropdown menu with the name of your controller appear in the **Control** tab, try specifying the `dev_file` attribute to match the exact path to your device.
8181
You can also try setting `auto_reconnect` to `True`.
8282

8383
You can find additional assistance in the [Troubleshooting section](/appendix/troubleshooting/).

docs/components/input-controller/mux.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Then remove and fill in the attributes as applicable to your input controller, a
5656
{{% /tab %}}
5757
{{< /tabs >}}
5858

59-
From the **Depends On** drop-down menu, select all of the source input controllers for your `mux` controller to combine.
59+
From the **Depends On** dropdown menu, select all of the source input controllers for your `mux` controller to combine.
6060

6161
{{% /tab %}}
6262
{{% tab name="JSON Template" %}}

docs/components/motor/fake.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The driver data sheet (for a real, not fake, motor) will specify which one to us
108108

109109
## Test the motor
110110

111-
Once your motor is configured and your robot is connected, go to the [**Control** tab](/manage/fleet/robots/#control) and click on the motor's drop-down panel.
111+
Once your motor is configured and your robot is connected, go to the [**Control** tab](/manage/fleet/robots/#control) and click on the motor's dropdown panel.
112112
Use the buttons to try turning your motor forwards or backwards at different power levels and notice how the **Position** number changes.
113113

114114
![Motor control panel.](/components/motor/control.png)

docs/components/movement-sensor/viam-visual-odometry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Follow the instructions below to set up the `monocular-visual-odometry` module o
5151
1. Select the `camera` type, then select the `webcam` model.
5252
1. Enter a name for your camera, then click **Create**.
5353
1. In the resulting camera component configuration pane, select a **Video path** for your camera.
54-
If your robot is live, the drop-down menu auto-populates any identified camera stream paths.
54+
If your robot is live, the dropdown menu auto-populates any identified camera stream paths.
5555
1. Then, click **Create component** in the lower-left corner again.
5656
1. Select **Movement Sensor**, then select `visual_odometry:opencv_orb`.
5757
You can also search for "visual_odometry".

docs/manage/fleet/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ Permissions are added at the organization level and apply to everything in an or
5656
- **Operator**: Can see and use only the [remote control tab](robots/#control).
5757
Cannot see or edit the [**Setup**](robots/#setup), [**Config**](robots/#configuration), [**History**](robots/#history), [**Logs**](robots/#logs), [**Code sample**](robots/#code-sample), or [**Security**](robots/#security) tabs.
5858

59-
To view the roles each organization member has, click on the organization drop down in the top navigation bar and click on **Settings**.
59+
To view the roles each organization member has, click on the organization dropdown in the top navigation bar and click on **Settings**.
6060

61-
If you have the **Owner** role, you can [invite new users](organizations/#invite-users-to-your-organization) and change the roles assigned to organization members using the role drop down for the respective user.
61+
If you have the **Owner** role, you can [invite new users](organizations/#invite-users-to-your-organization) and change the roles assigned to organization members using the role dropdown for the respective user.
6262

6363
![Example permissions overview](/manage/rbac.png)
6464

@@ -98,7 +98,7 @@ You and your collaborators can deploy control logic, {{< glossary_tooltip term_i
9898

9999
### Remote control
100100

101-
Everyone who has access to the robot can remotely control it on the app's [**Control** tab](robots/#control).
101+
Everyone who has access to the robot can remotely control it in the app's [**Control** tab](robots/#control).
102102
This allows you to visually test and remotely operate robot components and services.
103103

104104
You can also control a robot using the [Viam mobile app](#the-viam-mobile-app).

docs/manage/fleet/locations.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ Click a location's name to display the list of robots associated with that locat
4040
To create a sub-location you must first create the sub-location as a location and then choose a parent location:
4141

4242
1. Create a location and add at least one robot to it.
43-
2. At the bottom of the location's page, use the **New Parent Location** drop-down to choose a parent location.
43+
2. At the bottom of the location's page, use the **New Parent Location** dropdown to choose a parent location.
4444
3. Click **Change**.
4545

4646
You can nest locations up to three levels deep.
4747

48-
To move a sub-location to the top level of locations, select **Root** from the **New Parent Location** drop-down and then click **Change**.
48+
To move a sub-location to the top level of locations, select **Root** from the **New Parent Location** dropdown and then click **Change**.
4949

5050
### Share a location
5151

@@ -56,9 +56,9 @@ You can share a location beyond its organization by [sharing a location with an
5656

5757
#### Share a location with an additional organization
5858

59-
Share your location with another organization you belong to by selecting the organization from the **Add Organization** drop-down menu and clicking **Share**.
59+
Share your location with another organization you belong to by selecting the organization from the **Add Organization** dropdown menu and clicking **Share**.
6060

61-
![The Add Organization drop-down in the Viam app displays all organizations the user is a member of.](/manage/app-usage/add-org-drop-down.png)
61+
![The Add Organization dropdown in the Viam app displays all organizations the user is a member of.](/manage/app-usage/add-org-drop-down.png)
6262

6363
The location's page lists newly added organization, along with the organization identified as the **primary owner**:
6464

@@ -73,9 +73,9 @@ You can remove any organization except the primary owner from the shared list by
7373
7474
Grant programmatic access to your location by sharing a location secret key.
7575
76-
You can see the secret keys for a location in the **Location Secret Keys** drop-down:
76+
You can see the secret keys for a location in the **Location Secret Keys** dropdown:
7777
78-
![The list of secret keys that can grant access to a location displays in the location secret keys drop down menu of the Viam app.](/manage/app-usage/location-secret-keys-drop-down.png)
78+
![The list of secret keys that can grant access to a location displays in the location secret keys dropdown menu of the Viam app.](/manage/app-usage/location-secret-keys-dropdown.png)
7979
8080
{{< alert title="Caution" color="caution" >}}
8181
Do not share your location secret, part secret, or robot address publicly.

docs/manage/fleet/organizations.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ For example, you may have an account with one organization for your personal rob
2626
{{<youtube embed_url="https://www.youtube-nocookie.com/embed/eb7v6dabCGQ">}}
2727

2828
You organization is shown in the upper right corner of [the Viam app](https://app.viam.com).
29-
If you click on the organization drop down, the app displays your name, email, and a list of organizations you belong to.
29+
If you click on the organization dropdown, the app displays your name, email, and a list of organizations you belong to.
3030

31-
{{< imgproc alt="The org drop down showing an example user's name, email, Sign out button, list of organizations, and org settings button." src="/manage/app-usage/my-org.png" resize="400x" declaredimensions=true >}}
31+
{{< imgproc alt="The org dropdown showing an example user's name, email, Sign out button, list of organizations, and org settings button." src="/manage/app-usage/my-org.png" resize="400x" declaredimensions=true >}}
3232

3333
If you used an email invite to sign up, you have two organizations to begin with: the organization that invited you and a personal organization for other projects.
3434

docs/manage/fleet/robots.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Click the name of a robot to go to that robot's page, where you'll find a variet
2323

2424
## Navigating the robot page
2525

26-
The banner at the top of the robot page displays the robot's location, name, and a drop down list of all {{< glossary_tooltip term_id="part" text="parts" >}} of that robot.
26+
The banner at the top of the robot page displays the robot's location, name, and a dropdown list of all {{< glossary_tooltip term_id="part" text="parts" >}} of that robot.
2727

2828
If you've connected your robot to a machine running `viam-server`, the banner also displays when the robot was last online, which version of `viam-server` it is running, the host name, the IP address or addresses, and its operating system.
2929

@@ -106,7 +106,7 @@ Your robot and the Viam app communicate securely using [WebRTC](https://pkg.go.d
106106

107107
The **Security** tab allows you to access, generate, and delete the **Robot part secret keys** and the **Robot part API keys** of your robot.
108108

109-
![The Security tab of a robot`s page noting the Robot part API keys drop-down menu, with the clipboard icon on the far right and the Generate Key button underneath the drop-down.](/manage/app-usage/robot-secrets.png)
109+
![The Security tab of a robot`s page noting the Robot part API keys dropdown menu, with the clipboard icon on the far right and the Generate Key button underneath the dropdown.](/manage/app-usage/robot-secrets.png)
110110

111111
You can copy a secret by clicking on the clipboard icon.
112112

docs/manage/parts-and-remotes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ You can make a multi-part robot by first configuring one part which is the "main
3838
The main part will be able to access the resources of its sub-parts.
3939
Sub-parts will _not_ have access to the resources of the main part.
4040

41-
Use the parts drop-down menu in the top banner of your robot's page on the [Viam app](https://app.viam.com) to add a new sub-part:
41+
Use the parts dropdown menu in the top banner of your robot's page on the [Viam app](https://app.viam.com) to add a new sub-part:
4242

43-
![The Viam app interface with the part drop-down open. A new part called 'my-sub-part' is being created.](/manage/parts-and-remotes/sub-part-config.png)
43+
![The Viam app interface with the part dropdown open. A new part called 'my-sub-part' is being created.](/manage/parts-and-remotes/sub-part-config.png)
4444

4545
To delete a sub-part or make it the main part, use the buttons in the top right of the **Config** tab.
4646

docs/program/debug.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Read and filter a robot's logs to view updates from your robot's `viam-server` i
1515

1616
Navigate to the **Logs** tab of your robot's page in [the Viam app](https://app.viam.com).
1717

18-
Use the **Filter** input to filter the logs by key terms, and select from the **Levels** drop-down menu to filter the logs by warning level:
18+
Use the **Filter** input to filter the logs by key terms, and select from the **Levels** dropdown menu to filter the logs by warning level:
1919

2020
![Filtering by log level of info in the logs tab of the Viam app.](/program/sdks/log-level-info.png)
2121

0 commit comments

Comments
 (0)