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! |
Co-authored-by: nathan contino <[email protected]>
| 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 <file>meta.json</file> to reflect the new namespace. |
There was a problem hiding this comment.
@michaellee1019 questions:
- If this is recommended (per scope) but not required, why not?
a. If you push updates to a module without updating namespace, does it break things? - Scope doc only mentions public modules. What about private modules?
There was a problem hiding this comment.
I think you answered 1 in the scope google doc convo. For Nathan/other reviewer transparency:
Yes it breaks things if you make changes to the module code w/o updating the namespace, so it's better to just update it when you change the namespace so you don't run into weird problems later
|
|
||
| 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. |
There was a problem hiding this comment.
@michaellee1019 Here https://docs.viam.com/operate/get-started/other-hardware/manage-modules/#transfer-ownership-of-a-module we say
Update the model field in the configuration of any machines that use the module to use the new organization’s namespace.
But is this no longer necessary after this eng work?
There was a problem hiding this comment.
Per scope doc comment convo, I guess it was never necessary just recommended. I've added a fix to this PR.
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!)