From 78602ea4394e176201ab9e58af7a829ac8690827 Mon Sep 17 00:00:00 2001 From: andf-viam <132301587+andf-viam@users.noreply.github.com> Date: Mon, 11 Sep 2023 16:57:09 -0400 Subject: [PATCH] DOCS-1090: Note platform visibility in registry (#1795) --- docs/extend/modular-resources/upload/_index.md | 1 + docs/manage/CLI.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/docs/extend/modular-resources/upload/_index.md b/docs/extend/modular-resources/upload/_index.md index e885205da0..ce5893d8d9 100644 --- a/docs/extend/modular-resources/upload/_index.md +++ b/docs/extend/modular-resources/upload/_index.md @@ -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: diff --git a/docs/manage/CLI.md b/docs/manage/CLI.md index a19dcf4ffd..c6dae5cee2 100644 --- a/docs/manage/CLI.md +++ b/docs/manage/CLI.md @@ -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`).