-
Notifications
You must be signed in to change notification settings - Fork 41
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
DOCS 3128: Add platform tags #3710
Conversation
8f56c4a
to
e80c9da
Compare
docs/how-tos/upload-module.md
Outdated
@@ -264,6 +264,7 @@ where: | |||
You can only provide one `platform` argument at a time to the `viam module upload` command. | |||
See [Using the `--platform` argument](/cli/#using-the---platform-argument) for the full list of supported architectures. | |||
- `module-path`: provide the path to the file, directory, or compressed archive (with `.tar.gz` or `.tgz` extension) that contains your custom module code. | |||
- `tags`: provide a comma-serparated list of platform tags that determine to which this binary can be deployed. See [`viam module upload`](/cli/#module). |
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.
serparated
@@ -252,7 +252,7 @@ Run `viam module upload` to upload your custom module to the Viam Registry. | |||
Specify the path to the file, directory, or compressed archive (with `.tar.gz` or `.tgz` extension) that contains your custom module code: | |||
|
|||
```sh {id="terminal-prompt" class="command-line" data-prompt="$"} | |||
viam module upload --version <version> --platform <platform> <module-path> | |||
viam module upload --version <version> --platform <platform> <module-path> --tags=<tags> |
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.
note tags is optional; won't matter for most golang modules, matters for pyinstaller, mostly doesn't matter for source-only python, tbd for c++
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3710 |
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs (https://docs.viam.com)' |
@abe-winter can you review these tag descriptions please?
https://docs-test.viam.dev/3710/cli/#module