From 17133259d6bb2fd373d9da4061d533ccf6d67b02 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Fri, 25 Apr 2025 18:27:24 -0700 Subject: [PATCH 1/2] DOCS-3920: Add module build time note --- docs/operate/get-started/other-hardware/_index.md | 5 ++++- docs/operate/get-started/other-hardware/manage-modules.md | 3 ++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/operate/get-started/other-hardware/_index.md b/docs/operate/get-started/other-hardware/_index.md index 8f0986b6f4..35e1fe90f1 100644 --- a/docs/operate/get-started/other-hardware/_index.md +++ b/docs/operate/get-started/other-hardware/_index.md @@ -1087,7 +1087,10 @@ The `viam module generate` command already generated the `build-action` file in For details about versioning, see [Module versioning](/operate/reference/module-configuration/#module-versioning). 1. Click **Publish release**. - The cloud build action will begin building the new module version for each architecture listed in your meta.json, and any machines configured to use the latest release of the module will receive the update once it has finished building. + The cloud build action will begin building the new module version for each architecture listed in your meta.json. + The build can be quick or take over 15 minutes to complete, depending on factors including the size of the module. + + Any machines configured to use the latest release of the module will receive the update once it has finished building. See [Update an existing module using a GitHub action](/operate/get-started/other-hardware/manage-modules/#update-automatically) for more information. diff --git a/docs/operate/get-started/other-hardware/manage-modules.md b/docs/operate/get-started/other-hardware/manage-modules.md index 3902d8d231..798b70dcd2 100644 --- a/docs/operate/get-started/other-hardware/manage-modules.md +++ b/docs/operate/get-started/other-hardware/manage-modules.md @@ -234,7 +234,8 @@ For more details, see the [`upload-module` GitHub Action documentation](https:// 1. Add the key ID and value as GitHub repository secrets named `viam_key_id` and `viam_key_value`. -1. Push a tag or create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github) in GitHub to trigger the build. +1. Push a tag or create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github) in GitHub to trigger the build, which can take a number of minutes to complete depending on the size of the module. + Once the build is complete, the module will automatically update in the [Viam Registry](https://app.viam.com/registry), and the machines set to use the latest [version](/operate/reference/module-configuration/#module-versioning) of the module will automatically update to the new version. ### Update manually From b2461d1813c654fe951082a4197f6833fe8abb75 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Fri, 25 Apr 2025 18:30:12 -0700 Subject: [PATCH 2/2] just change one --- docs/operate/get-started/other-hardware/_index.md | 5 +---- docs/operate/get-started/other-hardware/manage-modules.md | 3 ++- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/operate/get-started/other-hardware/_index.md b/docs/operate/get-started/other-hardware/_index.md index 35e1fe90f1..8f0986b6f4 100644 --- a/docs/operate/get-started/other-hardware/_index.md +++ b/docs/operate/get-started/other-hardware/_index.md @@ -1087,10 +1087,7 @@ The `viam module generate` command already generated the `build-action` file in For details about versioning, see [Module versioning](/operate/reference/module-configuration/#module-versioning). 1. Click **Publish release**. - The cloud build action will begin building the new module version for each architecture listed in your meta.json. - The build can be quick or take over 15 minutes to complete, depending on factors including the size of the module. - - Any machines configured to use the latest release of the module will receive the update once it has finished building. + The cloud build action will begin building the new module version for each architecture listed in your meta.json, and any machines configured to use the latest release of the module will receive the update once it has finished building. See [Update an existing module using a GitHub action](/operate/get-started/other-hardware/manage-modules/#update-automatically) for more information. diff --git a/docs/operate/get-started/other-hardware/manage-modules.md b/docs/operate/get-started/other-hardware/manage-modules.md index 798b70dcd2..73c5e1a952 100644 --- a/docs/operate/get-started/other-hardware/manage-modules.md +++ b/docs/operate/get-started/other-hardware/manage-modules.md @@ -234,7 +234,8 @@ For more details, see the [`upload-module` GitHub Action documentation](https:// 1. Add the key ID and value as GitHub repository secrets named `viam_key_id` and `viam_key_value`. -1. Push a tag or create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github) in GitHub to trigger the build, which can take a number of minutes to complete depending on the size of the module. +1. Push a tag or create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github) in GitHub to trigger the build. + The build can be quick or take over 15 minutes to complete, depending on factors including the size of the module. Once the build is complete, the module will automatically update in the [Viam Registry](https://app.viam.com/registry), and the machines set to use the latest [version](/operate/reference/module-configuration/#module-versioning) of the module will automatically update to the new version.