From 52070bf65980e375b7a6e09144842fd3e16e6232 Mon Sep 17 00:00:00 2001 From: andf-viam <132301587+andf-viam@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:20:37 -0500 Subject: [PATCH] DOCS-1899: Remove update from module create (#2611) --- docs/fleet/cli.md | 2 +- docs/registry/upload/_index.md | 28 +++++----------------------- 2 files changed, 6 insertions(+), 24 deletions(-) diff --git a/docs/fleet/cli.md b/docs/fleet/cli.md index c275ba45c5..2ec6958905 100644 --- a/docs/fleet/cli.md +++ b/docs/fleet/cli.md @@ -527,7 +527,7 @@ If you update and release your module as part of a continuous integration (CI) w | command option | description | positional arguments | ----------- | ----------- | ----------- | | `create` | generate new metadata for a custom module on your local filesystem | - | -| `update` | update an existing custom module on your local filesystem with recent changes to the [`meta.json` file](#the-metajson-file) | - | +| `update` | update an existing custom module on your local filesystem with recent changes to the [`meta.json` file](#the-metajson-file). Note that the `upload` command automatically runs `update` for you; you do not need to explicitly run `update` if you are also running `upload` | - | | `upload` | validate and upload a new or existing custom module on your local filesystem to the Viam registry. See [Upload validation](#upload-validation) for more information | **module-path** : specify the path to the file, directory, or compressed archive (with `.tar.gz` or `.tgz` extension) that contains your custom module code | | `build start` | start a module build in a cloud runner using the build step in your [`meta.json` file](#the-metajson-file). See [Using the `build` subcommand](#using-the-build-subcommand) | - | | `build local` | start a module build locally using the build step in your [`meta.json` file](#the-metajson-file). See [Using the `build` subcommand](#using-the-build-subcommand) | - | diff --git a/docs/registry/upload/_index.md b/docs/registry/upload/_index.md index 95fc5ed6a8..1adaf05382 100644 --- a/docs/registry/upload/_index.md +++ b/docs/registry/upload/_index.md @@ -31,7 +31,7 @@ You can upload your module in one of two ways: ## Upload a custom module using the CLI -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: +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` and `upload` following these instructions: 1. First, [install the Viam CLI](/fleet/cli/#install) and [authenticate](/fleet/cli/#authenticate) to Viam, from the same machine that you intend to upload your module from. @@ -158,16 +158,7 @@ For more information, see [Naming your model](/registry/#naming-your-model-names See [`meta.json` file](/fleet/cli/#the-metajson-file) for more information. -4. Run `viam module update` to register the configuration changes you just made to `meta.json` with the Viam registry. - Run this command from within the same directory as your `meta.json` file: - - ```sh {id="terminal-prompt" class="command-line" data-prompt="$"} - viam module update - ``` - - On a successful update, the command will return a link to the updated module in the Viam registry. - -5. For modules written in Python, you should package your module files as an archive first, before uploading. +4. For modules written in Python, you should package your module files as an archive first, before uploading. Other languages can proceed to the next step to upload their module directly. To package a module written in Python, run the following command from the same directory as your `meta.json` file: @@ -179,7 +170,7 @@ For more information, see [Naming your model](/registry/#naming-your-model-names Supply the path to the resulting archive file in the next step. -6. Run `viam module upload` to upload your custom module to the Viam registry. +5. 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="$"} @@ -249,19 +240,10 @@ To update an existing module in the [Viam registry](https://app.viam.com/registr If you intend to make frequent code changes to your module, want to support a variety of platforms, or otherwise want to streamline your module development workflow, consider [using a GitHub action to update your module](#update-an-existing-module-using-a-github-action) instead. {{% /alert %}} -1. Edit your custom module with the changes you'd like to make. +1. Edit your custom module code with the changes you'd like to make. 1. Update your custom module's `meta.json` file with any needed changes. - For example, if you have altered your model's name, or adjusted the endpoint name, you'll need to update `meta.json` with these changes. - -1. Run `viam module update` to register the configuration changes you just made to `meta.json` with the Viam registry. - Run this command from within the same directory as your `meta.json` file: - - ```sh {id="terminal-prompt" class="command-line" data-prompt="$"} - viam module update - ``` - - On a successful update, the command will return a link to the updated module in the Viam registry. + For example, if you have altered your model's description, or adjusted the endpoint name, you'll need to update `meta.json` with these changes. 1. For modules written in Python, you should package your module files as an archive first, before uploading. Other languages can proceed to the next step to upload their module directly.