Skip to content
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

Merged
merged 2 commits into from
Nov 28, 2024
Merged

DOCS 3128: Add platform tags #3710

merged 2 commits into from
Nov 28, 2024

Conversation

npentrel
Copy link
Collaborator

@npentrel npentrel commented Nov 26, 2024

@abe-winter can you review these tag descriptions please?
Screenshot 2024-11-26 at 21 44 44

https://docs-test.viam.dev/3710/cli/#module

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Nov 26, 2024
@npentrel npentrel force-pushed the DOCS-3128 branch 2 times, most recently from 8f56c4a to e80c9da Compare November 26, 2024 20:47
docs/cli.md Outdated Show resolved Hide resolved
@@ -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).
Copy link
Member

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>
Copy link
Member

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++

@viambot
Copy link
Member

viambot commented Nov 28, 2024

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3710

@npentrel npentrel merged commit cd1f154 into viamrobotics:main Nov 28, 2024
9 checks passed
@npentrel npentrel deleted the DOCS-3128 branch November 28, 2024 14:53
Copy link

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs (https://docs.viam.com)'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants