diff --git a/docs/registry/examples/csi.md b/docs/registry/examples/csi.md index 1abc64abea..0c4bc33968 100644 --- a/docs/registry/examples/csi.md +++ b/docs/registry/examples/csi.md @@ -23,7 +23,6 @@ tags: aliases: - "/extend/registry/examples/csi/" - "/modular-resources/examples/csi/" - # SMEs: Sean --- diff --git a/docs/registry/upload/_index.md b/docs/registry/upload/_index.md index d04967a132..49670e1104 100644 --- a/docs/registry/upload/_index.md +++ b/docs/registry/upload/_index.md @@ -23,27 +23,6 @@ Once you have [created a custom module](/registry/create/), use the [Viam CLI](/ Once uploaded, you can also [update your modules](/registry/upload/#update-an-existing-module). -#### Naming your model: namespace:repo-name:name - -If you are [creating a custom module](/registry/create/) and want to [upload that module](/registry/upload/) to the Viam registry, ensure your model name meets the following requirements: - -- The namespace of your model **must** match the [namespace of your organization](/manage/fleet/organizations/#create-a-namespace-for-your-organization). - For example, if your organization uses the `acme` namespace, your models must all begin with `acme`, like `acme:demo:mybase`. -- Your model triplet must be all-lowercase. -- Your model triplet may only use alphanumeric (`a-z` and `0-9`), hyphen (`-`), and underscore (`_`) characters. - -For the middle segment of your model triplet `repo-name`, use the name of the git repository where you store your module's code. -The `repo-name` should describe the common functionality provided across the model or models of that module. - -For example: - -- The `rand:yahboom:arm` model and the `rand:yahboom:gripper` model uses the repository name [yahboom](https://github.com/viam-labs/yahboom). - The models implement the `rdk:component:arm` and the `rdk:component:gripper` API to support the Yahboom DOFBOT arm and gripper, respectively. -- The `viam-labs:audioout:pygame` model uses the repository name [audioout](https://github.com/viam-labs/audioout) - It implements the custom API `viam-labs:service:audioout`. - -The `viam` namespace is reserved for models provided by Viam. - ## Upload a custom module To upload your custom module to the [Viam registry](https://app.viam.com/registry), either as a public or private module, use the Viam CLI commands `create`, `upload`, and `update` following these instructions: @@ -133,7 +112,7 @@ If you mark your module as public, you cannot change it back to private.
models
api
and model
key pair. If you are publishing a public module ("visibility": "public"
), the namespace of your model must match the namespace of your organization.A list of one or more {{< glossary_tooltip term_id="model" text="models" >}} provided by your custom module. You must provide at least one model, which consists of an api
and model
key pair. If you are publishing a public module ("visibility": "public"
), the namespace of your model must match the namespace of your organization.
For more information, see naming your model.
entrypoint