Skip to content

Commit 3a117ba

Browse files
authored
DOCS-3530: Require namespace for module generation (#3989)
1 parent 005b27b commit 3a117ba

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/operate/get-started/other-hardware/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Authenticate your CLI session with Viam using one of the following options:
117117
| Module name | The module name describes the module or the family of devices it supports. It is generally the same as the name of the GitHub repo where you will put your module code. |
118118
| Language | The language for the module. |
119119
| Visibility | Choose `Private` to share only with your organization, or `Public` to share publicly with all organizations. If you are testing, choose `Private`. |
120-
| Namespace/Organization ID | In the [Viam app](https://app.viam.com), navigate to your organization settings through the menu in upper right corner of the page. Find the **Public namespace** (or create one if you haven't already) and copy that string. |
120+
| Namespace/Organization ID | In the [Viam app](https://app.viam.com), navigate to your organization settings through the menu in upper right corner of the page. Find the **Public namespace** (or create one if you haven't already) and copy that string. If you use the organization ID, you must still create a public namespace first. |
121121
| Resource to add to the module (API) | The [component API](/dev/reference/apis/#component-apis) your module will implement. |
122122
| Model name | Name your component model based on what it supports, for example, if it supports a model of ultrasonic sensor called “XYZ Sensor 1234” you could call your model `xyz_1234` or similar. Must be all-lowercase and use only alphanumeric characters (`a-z` and `0-9`), hyphens (`-`), and underscores (`_`). |
123123
| Enable cloud build | If you select `Yes` (recommended) and push the generated files (including the <file>.github</file> folder) and create a release of the format `vX.X.X`, the module will build and upload to the Viam registry and be available for all Viam-supported architectures without you needing to build for each architecture. `Yes` also makes it easier to [upload](#upload-your-module) using PyInstaller by creating a build entrypoint script. You can select `No` if you will always build the module yourself before uploading it. |

docs/operate/get-started/other-hardware/hello-world-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ First let's generate the camera component files, and we'll add the sensor code l
210210
- Visibility: `Private`
211211
- Namespace/Organization ID:
212212
- In the [Viam app](https://app.viam.com), navigate to your organization settings through the menu in upper right corner of the page.
213-
Find the **Public namespace** and copy that string.
213+
Find the **Public namespace** (or create one if you haven't already) and copy that string.
214214
In the example snippets below, the namespace is `jessamy`.
215215
- Resource to add to the module (API): `Camera Component`.
216216
We will add the sensor later.

0 commit comments

Comments
 (0)