-
Notifications
You must be signed in to change notification settings - Fork 48
DOCS-3693: Update module and namespace renaming #4418
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
promptless
wants to merge
6
commits into
main
Choose a base branch
from
3693renames
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
dedab94
Documentation updates from Promptless
promptless[bot] 0c043dd
Update docs/operate/reference/naming-modules.md
JessamyT 2abe51e
Apply suggestions from code review
JessamyT 84cbba4
Apply suggestions from code review
JessamyT 1cdd36a
Apply suggestions from code review
JessamyT 6509d46
Clarify recs vs necessity of updating configs
JessamyT File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 [[email protected]](mailto:[email protected]). | ||
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/<namespace>/<module-name>`. | ||
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 %}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@michaellee1019 questions:
a. If you push updates to a module without updating namespace, does it break things?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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