DOCS-3693: Update module and namespace renaming #4418
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
|
Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.) |
|
👋 Thanks for contributing! A reviewer will look at it on the next working day! |
| @@ -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. | |||
There was a problem hiding this comment.
| You can now rename modules and organization namespaces through the web interface. | |
| You can now rename modules and organization namespaces through the web UI. |
optional: should we say "web UI" here for consistency/findability?
| 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. |
There was a problem hiding this comment.
| 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. | |
| When you rename a module, the old module name cannot be reused. | |
| References to the old module name will continue to work. |
optional: I don't love the nonstandard 'notes:' introduction here. Besides, at least two of these bullet points are obvious, redundant with the first sentence, or not necessary to point out here. Suggesting a couple of sentences to cover the basics instead.
| @@ -416,7 +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 [[email protected]](mailto:[email protected]). | |||
| You can rename a module that you own through the Viam web interface. | |||
There was a problem hiding this comment.
| 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. |
suggestion: be explicit, since a user never owns a module, an organization does; avoid contradicting the bullet point a few lines down
|
|
||
| ## 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. |
There was a problem hiding this comment.
| 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 the organization settings page. |
optional: avoid unnecessary pronouns, avoid unnecessary 'if' conditional
|
|
||
| To rename your organization's namespace: | ||
|
|
||
| 1. Navigate to your organization settings at `app.viam.com/organization/<org-id>/settings`. |
There was a problem hiding this comment.
| 1. Navigate to your organization settings at `app.viam.com/organization/<org-id>/settings`. | |
| 1. Navigate to your organization settings at `app.viam.com/organization/<org-id>/settings`. |
suggestion: I would prefer a clickable link, maybe we can start at the organization page and guide users to the settings page for a specific organization from there? That way we could create a clickable link to https://app.viam.com/organization/, assuming that page exists
| 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. | ||
| - 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. |
There was a problem hiding this comment.
| 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. | |
| - 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. | |
| When you rename a namespace, the old namespace name cannot be reused. | |
| References to the old namespace name will continue to work. | |
| You can rename a namespace no more than 5 times. |
optional: similar reasoning as above, though a bulleted list would work fine here as well (not doing that for consistency with the above section). It might be good to fact check the '5 namespaces' limit -- does that mean you can rename 5 times, or that you can rename only 4 times, or that when you rename the 5th time, the oldest namespace alias will stop working? That's a really important detail!
One caveat: I don't know what this line means, but it seems awfully important:
You need to change model names for public modules after a namespace change.
Seems to directly contradict the 'existing machine configureations will continue to work without any changes needed' line. But big if true. So someone really ought to investigate.
Update documentation to reflect the new functionality that allows users to rename modules and organization namespaces through the Viam web interface. This replaces the previous requirement to contact support for module renaming and adds new namespace renaming capabilities.
Key Updates Needed:
Scope Description from User:
Trigger Events
If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)