From 87563100bba2de9aca34f8bfd7c99f5ca5f97e7b Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 1 Oct 2024 08:58:13 -0600 Subject: [PATCH 1/2] Add cron expressions to sidebar --- docs/enterprise/updating-apps.mdx | 2 +- docs/reference/cron-expressions.md | 4 +++- netlify.toml | 2 +- sidebars.js | 1 + 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/enterprise/updating-apps.mdx b/docs/enterprise/updating-apps.mdx index 02d7a74107..c8edeeba4c 100644 --- a/docs/enterprise/updating-apps.mdx +++ b/docs/enterprise/updating-apps.mdx @@ -34,7 +34,7 @@ To configure automatic updates: To turn off automatic updates, select **Never**. - To define a custom cadence, select **Custom**, then enter a cron expression in the text field. For more information about cron expressions, see [Cron Expressions](/reference/cron-expressions) in _Reference_. Configured automatic update checks use the local server time. + To define a custom cadence, select **Custom**, then enter a cron expression in the text field. For more information about cron expressions, see [Cron Expressions](/reference/cron-expressions). Configured automatic update checks use the local server time. ![Configure automatic updates](/images/automatic-updates-config.png) diff --git a/docs/reference/cron-expressions.md b/docs/reference/cron-expressions.md index 8de007079b..df112f3ddc 100644 --- a/docs/reference/cron-expressions.md +++ b/docs/reference/cron-expressions.md @@ -1,6 +1,8 @@ # Cron Expressions -This topic describes the supported cron expressions that youc an use to schedule automatic application update checks and automatic backups in the Replicated admin console. For more information, see [Configuring Automatic Updates](/enterprise/updating-apps) and [Schedule Automatic Backups](/enterprise/snapshots-creating#schedule-automatic-backups) in _Creating and Scheduling Backups_. +This topic describes the supported cron expressions that you can use to schedule automatic application update checks and automatic backups in the KOTS Admin Console. + +For more information, see [Configuring Automatic Updates](/enterprise/updating-apps) and [Schedule Automatic Backups](/enterprise/snapshots-creating#schedule-automatic-backups) in _Creating and Scheduling Backups_. ## Syntax diff --git a/netlify.toml b/netlify.toml index 80b0270ed0..784944e782 100644 --- a/netlify.toml +++ b/netlify.toml @@ -36,7 +36,7 @@ [[redirects]] from = "https://docs.replicated.com/reference" - to = "https://docs.replicated.com/reference/cron-expressions" + to = "https://docs.replicated.com/reference/kots-cli-getting-started" [[redirects]] from = "https://docs.replicated.com/release-notes" diff --git a/sidebars.js b/sidebars.js index b1cefe90ff..f7f7a52470 100644 --- a/sidebars.js +++ b/sidebars.js @@ -498,6 +498,7 @@ const sidebars = { 'reference/template-functions-static-context', ], }, + 'reference/cron-expressions', ], }, 'vendor/install-with-helm', From b4944e876a5b602936ad5e4ae3d7e2aaabccb5b7 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 1 Oct 2024 09:02:23 -0600 Subject: [PATCH 2/2] branding --- docs/reference/cron-expressions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/cron-expressions.md b/docs/reference/cron-expressions.md index df112f3ddc..1420e06223 100644 --- a/docs/reference/cron-expressions.md +++ b/docs/reference/cron-expressions.md @@ -124,7 +124,7 @@ You can use one of the following predefined schedule values instead of a cron ex @default -

Selects the default schedule option (every 4 hours). Begins when the admin console starts up.

This value can be useful when you are calling the API directly or are editing the KOTS configuration manually.

+

Selects the default schedule option (every 4 hours). Begins when the Admin Console starts up.

This value can be useful when you are calling the API directly or are editing the KOTS configuration manually.

0 * * * * @@ -137,7 +137,7 @@ You can also schedule the job to operate at fixed intervals, starting at the tim @every DURATION ``` -Replace `DURATION` with a string that is accepted by time.ParseDuration, with the exception of seconds. Seconds are not supported by Replicated KOTS. For more information about duration strings, see [time.ParseDuration](http://golang.org/pkg/time/#ParseDuration) in the Go Time documentation. +Replace `DURATION` with a string that is accepted by time.ParseDuration, with the exception of seconds. Seconds are not supported by KOTS. For more information about duration strings, see [time.ParseDuration](http://golang.org/pkg/time/#ParseDuration) in the Go Time documentation. As with standard cron expressions, the interval does not include the job runtime. For example, if a job is scheduled to run every 10 minutes, and the job takes 4 minutes to run, there are 6 minutes of idle time between each run.