Skip to content

Commit

Permalink
DOCS-1090: Note platform visibility in registry (#1795)
Browse files Browse the repository at this point in the history
  • Loading branch information
andf-viam authored Sep 11, 2023
1 parent 0206626 commit 78602ea
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/extend/modular-resources/upload/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ To upload your custom module to the Viam Registry, either as a public or private
The `viam module upload` command only supports one `platform` argument at a time.
If you would like to upload your module with support for multiple platforms, you must run a separate `viam module upload` command for each platform.
Use the *same version number* when running multiple `upload` commands of the same module code if only the `platform` support differs.
The Viam registry page for your module displays the platforms your module supports for each version you have uploaded.
{{% /alert %}}
For example, the following command uploads the compressed `module.tar.gz` archive to the Viam Registry when run in the same directory as the corresponding `meta.json` file:
Expand Down
2 changes: 2 additions & 0 deletions docs/manage/CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,8 @@ The `viam module upload` command only supports one `platform` argument at a time
If you would like to upload your module with support for multiple platforms, you must run a separate `viam module upload` command for each platform.
Use the *same version number* when running multiple `upload` commands of the same module code if only the `platform` support differs.

The Viam registry page for your module displays the platforms your module supports for each version you have uploaded.

##### Using the `--version` argument

The `--version` argument accepts a valid [semver 2.0](https://semver.org/) version (example: `1.0.0`).
Expand Down

0 comments on commit 78602ea

Please sign in to comment.