From dedab947b49b2aa4cfcb4b15f287187a451bae9c Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 27 Jun 2025 20:27:03 +0000 Subject: [PATCH 1/6] Documentation updates from Promptless --- docs/dev/reference/changelog.md | 7 +++++++ .../other-hardware/manage-modules.md | 16 ++++++++++++++-- docs/operate/reference/naming-modules.md | 19 +++++++++++++++++++ 3 files changed, 40 insertions(+), 2 deletions(-) diff --git a/docs/dev/reference/changelog.md b/docs/dev/reference/changelog.md index 699fc9e402..09d2f28572 100644 --- a/docs/dev/reference/changelog.md +++ b/docs/dev/reference/changelog.md @@ -42,6 +42,13 @@ date: "2024-09-18" # updated: "" # When the content was last entirely checked --- +{{% changelog color="added" title="Module and namespace renaming" date="2025-06-09" %}} + +You can now rename modules and organization namespaces through the web interface. +For more information, see [Rename a module](/operate/get-started/other-hardware/manage-modules/#rename-a-module) and [Update a namespace for your organization](/operate/reference/naming-modules/#update-a-namespace-for-your-organization). + +{{% /changelog %}} + {{% changelog color="added" title="Move machines between locations" date="2025-06-10" %}} Organization owners and location owners can now move machines between locations within their organization using the web UI. diff --git a/docs/operate/get-started/other-hardware/manage-modules.md b/docs/operate/get-started/other-hardware/manage-modules.md index d31818ad80..17bd6fff72 100644 --- a/docs/operate/get-started/other-hardware/manage-modules.md +++ b/docs/operate/get-started/other-hardware/manage-modules.md @@ -416,9 +416,21 @@ To transfer ownership of a module from one organization to another: ## Rename a module -If you need to change the name of a module, please reach out to the Viam team at [support@viam.com](mailto:support@viam.com). +You can rename a module that you own through the Viam web interface. +To rename a module: -{{% hiddencontent %}} +1. Navigate to your module page at `app.viam.com/module//`. +1. Click the **...** menu in the top right corner of the module page. +1. Select **Rename** from the dropdown menu. +1. Enter the new module name in the modal that appears. +1. Click **Rename** to confirm the change. + +Notes: + +- The old module name is permanently reserved for backwards compatibility and cannot be reused. +- Existing machine configurations will continue to work without any changes required. +- When adding the module to new machines, the machine builder will use the new module name. +- You can only rename modules that your organization owns. ## Rename a model diff --git a/docs/operate/reference/naming-modules.md b/docs/operate/reference/naming-modules.md index c56a3eff74..1b39ade594 100644 --- a/docs/operate/reference/naming-modules.md +++ b/docs/operate/reference/naming-modules.md @@ -102,3 +102,22 @@ When uploading modules to the Viam Registry, you must set a unique namespace for To create a new namespace for your organization, click on the org's **Settings** in the top right of the navigation bar, then click the **Set a public namespace** button. Enter a name or use the suggested name for your namespace, and then click **Set namespace**. A namespace may only contain letters, numbers, and the dash (`-`) character. + +## Update a namespace for your organization + +If your organization already has a namespace and you need to change it, you can rename it through the organization settings page. + +To rename your organization's namespace: + +1. Navigate to your organization settings at `app.viam.com/organization//settings`. +1. Click the **Rename** button next to your current namespace. +1. Enter the new namespace name in the modal that appears. +1. Click **Set namespace** to confirm the change. + +Notes: + +- The old namespace is permanently reserved for backwards compatibility and cannot be reused. +- Existing machine configurations will continue to work without any changes required. +- Model names for public modules will need to be changed after a namespace change. +- Organizations are limited to 5 namespaces total to prevent abuse. +- When adding modules to new machines, the machine builder will use the new namespace. From 0c043dd5815d598c8495be968f5f71e5452830f6 Mon Sep 17 00:00:00 2001 From: Jessamy Taylor <75634662+JessamyT@users.noreply.github.com> Date: Fri, 27 Jun 2025 13:29:15 -0700 Subject: [PATCH 2/6] Update docs/operate/reference/naming-modules.md --- docs/operate/reference/naming-modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/operate/reference/naming-modules.md b/docs/operate/reference/naming-modules.md index 1b39ade594..8040b760c3 100644 --- a/docs/operate/reference/naming-modules.md +++ b/docs/operate/reference/naming-modules.md @@ -118,6 +118,6 @@ Notes: - The old namespace is permanently reserved for backwards compatibility and cannot be reused. - Existing machine configurations will continue to work without any changes required. -- Model names for public modules will need to be changed after a namespace change. +- You need to change model names for public modules after a namespace change. - Organizations are limited to 5 namespaces total to prevent abuse. - When adding modules to new machines, the machine builder will use the new namespace. From 2abe51ea9df88f83f98a7c6f17c1d257b9416a7f Mon Sep 17 00:00:00 2001 From: Jessamy Taylor <75634662+JessamyT@users.noreply.github.com> Date: Fri, 27 Jun 2025 14:05:58 -0700 Subject: [PATCH 3/6] Apply suggestions from code review --- docs/operate/get-started/other-hardware/manage-modules.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/operate/get-started/other-hardware/manage-modules.md b/docs/operate/get-started/other-hardware/manage-modules.md index 17bd6fff72..a07dc4c5ca 100644 --- a/docs/operate/get-started/other-hardware/manage-modules.md +++ b/docs/operate/get-started/other-hardware/manage-modules.md @@ -425,13 +425,15 @@ To rename a module: 1. Enter the new module name in the modal that appears. 1. Click **Rename** to confirm the change. -Notes: +Notes: - The old module name is permanently reserved for backwards compatibility and cannot be reused. - Existing machine configurations will continue to work without any changes required. - When adding the module to new machines, the machine builder will use the new module name. - You can only rename modules that your organization owns. +{{% hiddencontent %}} + ## Rename a model If you need to change the name of a model that a module implements, do the following: From 84cbba4f7aab9ccded3d9c061de1777e1ab90f28 Mon Sep 17 00:00:00 2001 From: Jessamy Taylor <75634662+JessamyT@users.noreply.github.com> Date: Tue, 1 Jul 2025 14:51:55 -0700 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: nathan contino --- docs/dev/reference/changelog.md | 2 +- .../operate/get-started/other-hardware/manage-modules.md | 9 +++------ docs/operate/reference/naming-modules.md | 6 ++---- 3 files changed, 6 insertions(+), 11 deletions(-) diff --git a/docs/dev/reference/changelog.md b/docs/dev/reference/changelog.md index 09d2f28572..f1a5cd2803 100644 --- a/docs/dev/reference/changelog.md +++ b/docs/dev/reference/changelog.md @@ -44,7 +44,7 @@ date: "2024-09-18" {{% changelog color="added" title="Module and namespace renaming" date="2025-06-09" %}} -You can now rename modules and organization namespaces through the web interface. +You can now rename modules and organization namespaces through the web UI. For more information, see [Rename a module](/operate/get-started/other-hardware/manage-modules/#rename-a-module) and [Update a namespace for your organization](/operate/reference/naming-modules/#update-a-namespace-for-your-organization). {{% /changelog %}} diff --git a/docs/operate/get-started/other-hardware/manage-modules.md b/docs/operate/get-started/other-hardware/manage-modules.md index a07dc4c5ca..16ff0e9b54 100644 --- a/docs/operate/get-started/other-hardware/manage-modules.md +++ b/docs/operate/get-started/other-hardware/manage-modules.md @@ -416,7 +416,7 @@ To transfer ownership of a module from one organization to another: ## Rename a module -You can rename a module that you own through the Viam web interface. +You can rename a module that your organization owns through the Viam web interface. To rename a module: 1. Navigate to your module page at `app.viam.com/module//`. @@ -425,12 +425,9 @@ To rename a module: 1. Enter the new module name in the modal that appears. 1. Click **Rename** to confirm the change. -Notes: +When you rename a module, the old module name is reserved for backwards compatibility cannot be reused. -- The old module name is permanently reserved for backwards compatibility and cannot be reused. -- Existing machine configurations will continue to work without any changes required. -- When adding the module to new machines, the machine builder will use the new module name. -- You can only rename modules that your organization owns. +Existing machine configurations containing the old module name will continue to work. {{% hiddencontent %}} diff --git a/docs/operate/reference/naming-modules.md b/docs/operate/reference/naming-modules.md index 8040b760c3..fb60379d9c 100644 --- a/docs/operate/reference/naming-modules.md +++ b/docs/operate/reference/naming-modules.md @@ -105,11 +105,9 @@ A namespace may only contain letters, numbers, and the dash (`-`) character. ## Update a namespace for your organization -If your organization already has a namespace and you need to change it, you can rename it through the organization settings page. +You can change your organization's namespace on your organization settings page: -To rename your organization's namespace: - -1. Navigate to your organization settings at `app.viam.com/organization//settings`. +1. Navigate to your organization settings page using the dropdown in the upper right corner of the web UI. 1. Click the **Rename** button next to your current namespace. 1. Enter the new namespace name in the modal that appears. 1. Click **Set namespace** to confirm the change. From 1cdd36a739f02e27d9858f626c4b4767954e9f74 Mon Sep 17 00:00:00 2001 From: Jessamy Taylor <75634662+JessamyT@users.noreply.github.com> Date: Wed, 2 Jul 2025 12:04:49 -0700 Subject: [PATCH 5/6] Apply suggestions from code review --- .../operate/get-started/other-hardware/manage-modules.md | 2 +- docs/operate/reference/naming-modules.md | 9 +++------ 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/operate/get-started/other-hardware/manage-modules.md b/docs/operate/get-started/other-hardware/manage-modules.md index 16ff0e9b54..80636058ed 100644 --- a/docs/operate/get-started/other-hardware/manage-modules.md +++ b/docs/operate/get-started/other-hardware/manage-modules.md @@ -425,7 +425,7 @@ To rename a module: 1. Enter the new module name in the modal that appears. 1. Click **Rename** to confirm the change. -When you rename a module, the old module name is reserved for backwards compatibility cannot be reused. +When you rename a module, Viam reserves the old module name for backwards compatibility and you cannot reuse it. Existing machine configurations containing the old module name will continue to work. diff --git a/docs/operate/reference/naming-modules.md b/docs/operate/reference/naming-modules.md index fb60379d9c..8e2d5996c4 100644 --- a/docs/operate/reference/naming-modules.md +++ b/docs/operate/reference/naming-modules.md @@ -111,11 +111,8 @@ You can change your organization's namespace on your organization settings page: 1. Click the **Rename** button next to your current namespace. 1. Enter the new namespace name in the modal that appears. 1. Click **Set namespace** to confirm the change. +1. For each module your organization owns, update the module code and meta.json to reflect the new namespace. -Notes: +When you rename a namespace, Viam reserves the old namespace for backwards compatibility and you cannot reuse it. -- The old namespace is permanently reserved for backwards compatibility and cannot be reused. -- Existing machine configurations will continue to work without any changes required. -- You need to change model names for public modules after a namespace change. -- Organizations are limited to 5 namespaces total to prevent abuse. -- When adding modules to new machines, the machine builder will use the new namespace. +Machine configurations that reference the old namespace will continue to work. From 6509d4626b9d8c1b0dad8fe7e5b411879bf42e22 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Wed, 2 Jul 2025 15:49:48 -0700 Subject: [PATCH 6/6] Clarify recs vs necessity of updating configs --- docs/operate/get-started/other-hardware/manage-modules.md | 6 ++++-- docs/operate/reference/naming-modules.md | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/operate/get-started/other-hardware/manage-modules.md b/docs/operate/get-started/other-hardware/manage-modules.md index 80636058ed..2761567d6c 100644 --- a/docs/operate/get-started/other-hardware/manage-modules.md +++ b/docs/operate/get-started/other-hardware/manage-modules.md @@ -412,7 +412,8 @@ To transfer ownership of a module from one organization to another: 1. Publish a new version of the module to the registry by following either set of update steps on this page. This ensures that the model names in the module code match the registered model names in the registry. -1. Update the `model` field in the configuration of any machines that use the module to use the new organization's namespace. +1. (Recommended) Update the `model` field in the configuration of any machines that use the module to use the new organization's namespace. + Viam maintains backwards compatibility with the old namespace, but you should update the configuration to use the new namespace to avoid confusion. ## Rename a module @@ -443,6 +444,7 @@ If you need to change the name of a model that a module implements, do the follo 1. Publish a new version of the module to the registry by following either set of update steps on this page. -1. Update the configuration of any machines that use the module to use the new model name. +1. (Recommended) Update the configuration of any machines that use the module to use the new model name. + Viam maintains backwards compatibility with the old model name, but updating the configuration is recommended to avoid confusion. {{% /hiddencontent %}} diff --git a/docs/operate/reference/naming-modules.md b/docs/operate/reference/naming-modules.md index 8e2d5996c4..65b29c67af 100644 --- a/docs/operate/reference/naming-modules.md +++ b/docs/operate/reference/naming-modules.md @@ -112,7 +112,7 @@ You can change your organization's namespace on your organization settings page: 1. Enter the new namespace name in the modal that appears. 1. Click **Set namespace** to confirm the change. 1. For each module your organization owns, update the module code and meta.json to reflect the new namespace. +1. (Recommended) Update the `model` field in the configuration of any machines that use the module to use the new organization's namespace. + Machine configurations that reference the old namespace will continue to work, but we recommend updating them to use the new namespace to avoid confusion. When you rename a namespace, Viam reserves the old namespace for backwards compatibility and you cannot reuse it. - -Machine configurations that reference the old namespace will continue to work.