diff --git a/docs/dev/reference/changelog.md b/docs/dev/reference/changelog.md index b9c3162323..dd3ad57896 100644 --- a/docs/dev/reference/changelog.md +++ b/docs/dev/reference/changelog.md @@ -60,6 +60,13 @@ Organization owners and location owners can now move machines between locations {{% /changelog %}} +{{% changelog color="added" title="Module and namespace renaming" date="2025-06-09" %}} + +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 %}} + {{% changelog color="removed" title="Frame tab removed, use Add Frame button" date="2025-05-15" %}} The frame tab no longer exists. diff --git a/docs/operate/get-started/other-hardware/manage-modules.md b/docs/operate/get-started/other-hardware/manage-modules.md index d31818ad80..2761567d6c 100644 --- a/docs/operate/get-started/other-hardware/manage-modules.md +++ b/docs/operate/get-started/other-hardware/manage-modules.md @@ -412,11 +412,23 @@ 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 -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 your organization owns through the Viam web interface. +To rename a module: + +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. + +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. {{% hiddencontent %}} @@ -432,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 c56a3eff74..65b29c67af 100644 --- a/docs/operate/reference/naming-modules.md +++ b/docs/operate/reference/naming-modules.md @@ -102,3 +102,17 @@ 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 + +You can change your organization's namespace on your organization settings page: + +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. +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.