docs update

cloudposse · Dec 13, 2024 · e3a2e5e · e3a2e5e
1 parent ea7fc1b
commit e3a2e5e
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/website/docs/cli/commands/help.mdx b/website/docs/cli/commands/help.mdx
@@ -12,6 +12,13 @@ import Terminal from '@site/src/components/Terminal'
 ## Usage
 
 The `atmos --help` and `atmos -h` commands show help for all Atmos CLI commands.
+Please note that an atmos upgrage version box is shown at the end of each help command.
+The frequency with which the update box message is shown is configured in atmos.yaml.
+There are two options daily and weekly. The default value is set to daily. 
+It is also possible to turn it off in atmos.yaml file by switching enable to false. 
+Or set an env variable ATMOS_VERSION_CHECK_ENABLED to false, 
+this overriders the config's settting. 
+
 
 ```shell
 atmos help

diff --git a/website/docs/cli/commands/version.mdx b/website/docs/cli/commands/version.mdx
@@ -20,7 +20,19 @@ Execute the `atmos version` command like this:
 atmos version
 ```
 
-This will show the CLI version.
+This will show the CLI version. 
+The frequency with which the update box message in version is shown is configured in atmos.yaml.
+There are two options daily and weekly. The default value is set to daily. 
+It is also possible to turn it off in atmos.yaml file by switching enable to false. 
+Or set an env variable ATMOS_VERSION_CHECK_ENABLED to false, 
+this overriders the config's settting. 
+
+```shell
+atmos version --check
+```
+
+The version command supports --check flag. 
+It will show the update box message irrespectively of the config settings.  
 
 :::tip
 To find the latest version of Atmos, go to the [releases](https://github.com/cloudposse/atmos/releases) page on GitHub.