From c994839e3161880bb9078c894b7a398a159768de Mon Sep 17 00:00:00 2001 From: Nikki Everett Date: Fri, 9 Feb 2024 11:09:34 -0600 Subject: [PATCH] prevent asterisk from being turned into list element (#4836) Signed-off-by: nikki everett --- docs/concepts/schedules.rst | 120 ++++++++++++++++++++++++++++++------ 1 file changed, 101 insertions(+), 19 deletions(-) diff --git a/docs/concepts/schedules.rst b/docs/concepts/schedules.rst index 34644b217b3..092a67f4a13 100644 --- a/docs/concepts/schedules.rst +++ b/docs/concepts/schedules.rst @@ -24,37 +24,116 @@ Let's now look at how schedules can be defined through cron_expression_ or rate_ Cron Expression --------------- -Cron expression strings use :ref:`this ` syntax. They are validated at launch plan registration time. - -.. _rate_unit: +Cron expression strings use the syntax shown below. They are validated at launch plan registration time. Format ------ A cron expression represents a set of times, with the help of 5 space-separated fields. -.. _cron_expression_table: - -+--------------+------------+-----------------+----------------------------+ -| Field name | Mandatory? | Allowed values | Allowed special characters | -+==============+============+=================+============================+ -| Minutes | Yes | 0-59 | * / , - | -+--------------+------------+-----------------+----------------------------+ -| Hours | Yes | 0-23 | * / , - | -+--------------+------------+-----------------+----------------------------+ -| Day of month | Yes | 1-31 | * / , - ? | -+--------------+------------+-----------------+----------------------------+ -| Month | Yes | 1-12 or JAN-DEC | * / , - | -+--------------+------------+-----------------+----------------------------+ -| Day of week | Yes | 0-6 or SUN-SAT | * / , - ? | -+--------------+------------+-----------------+----------------------------+ +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Field name

+
+

Required

+
+

Allowed values

+
+

Allowed special characters

+
+

Minutes

+
+

Yes

+
+

0-59

+
+

* / , -

+

Hours

+

Yes

+
+

0-23

+
+

* / , -

+
+

Day of month

+
+

Yes

+
+

1-31

< +
+

/ , - ?

+
+

Month

+
+

Yes

+
+

1-12 or JAN-DEC

+
+

* / , -

+
+

Day of week

+
+

Yes

+
+

0-6 or SUN-SAT

+
+

* / , - ?

+
**Note**: The 'Month' and 'Day of week' fields are case insensitive. Cron schedules -------------- -An incorrect cron schedule expression leads to a failure in triggering the schedule. :ref:`Here ` is a table that shows the format of a cron expression. +An incorrect cron schedule expression leads to a failure in triggering the schedule. :ref:`Here ` is a table that shows the format of a cron expression. Below is another example: @@ -73,6 +152,8 @@ Below is another example: ) +.. _fixed_rate: + Fixed rate schedules ---------------------- Instead of cron schedules, fixed rate schedules can be used. @@ -95,6 +176,7 @@ Below is an example with duration in `days`. ) +.. _rate_unit: Rate Unit ---------