diff --git a/docs/operate/modules/other-hardware/module-configuration.md b/docs/operate/modules/other-hardware/module-configuration.md index 2e1c90ded2..255895389f 100644 --- a/docs/operate/modules/other-hardware/module-configuration.md +++ b/docs/operate/modules/other-hardware/module-configuration.md @@ -75,7 +75,7 @@ The following properties are available for modular resources: | Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `attributes` | object | Sometimes **Required** | Any configuration attributes for your model Check the module's GitHub Readme for information about available configuration attributes for a resource. | -| `name` | string | **Required** | The name of this instance of a modular resource. The name can only contain letters, numbers, dashes, and underscores. Resource names must be unique across all {{< glossary_tooltip term_id="part" text="parts" >}} of a machine. | +| `name` | string | **Required** | The name of this instance of a modular resource. The name can only contain letters, numbers, dashes, and underscores. Resource names must be unique across all {{< glossary_tooltip term_id="part" text="parts" >}} of a machine. In case of name collisions with a remote, you can add a [`prefix` to the remote](/operate/reference/architecture/parts/#configure-a-remote-part). | | `api` | string | **Required** | The {{< glossary_tooltip term_id="api-namespace-triplet" text="API namespace triplet">}}. | | `model` | string | **Required** | The full {{< glossary_tooltip term_id="model-namespace-triplet" text="model namespace triplet">}} of the modular resource's {{< glossary_tooltip term_id="model" text="model" >}}. | | `depends_on` | array | Optional | The `name` of resources you want to confirm are available on your machine alongside your modular resource. Unnecessary if you coded [implicit dependencies](/operate/modules/other-hardware/create-module/dependencies/). | diff --git a/docs/operate/reference/architecture/parts.md b/docs/operate/reference/architecture/parts.md index 1330b4f2f5..c3702f06b4 100644 --- a/docs/operate/reference/architecture/parts.md +++ b/docs/operate/reference/architecture/parts.md @@ -135,6 +135,7 @@ To establish a connection between a part of one machine and a part of a second m | `address` | string | Optional | The address of the remote part. | | `auth` | string | Object | The authentication credentials of the remote part. For example: `{ "credential": { "type": "api-key", "payload": "abcdefghijklmnop123456789abcdefg" } }`. | | `prefix` | string | Optional | If set, all resource names fetched from the remote part will have the prefix. For example, a component with the name `arm-1` configured on a remote part with the configuration `"prefix": "test123"` returns the name `test123arm-1`. | + | `notes` | string | Optional | Descriptive text to document the purpose, configuration details, or other important information about this remote part. | 1. Click **Save** in the upper right corner of the page to save your config.