Skip to content

Commit 0d3def4

Browse files
docs(serverless): rework documentation (#3026)
Co-authored-by: Rémy Léone <rleone@scaleway.com>
1 parent dd396b9 commit 0d3def4

File tree

31 files changed

+287
-216
lines changed

31 files changed

+287
-216
lines changed

cmd/scw/testdata/test-all-usage-function-cron-create-usage.golden

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a new cron.
3+
Create a new cronjob for a function with the specified ID.
44

55
USAGE:
66
scw function cron create [arg=value ...]
77

88
ARGS:
9-
[function-id]
10-
[schedule]
11-
[args]
12-
[name]
9+
[function-id] UUID of the function to use the cron with
10+
[schedule] Schedule of the cron in UNIX cron format
11+
[args] Arguments to use with the cron
12+
[name] Name of the cron
1313
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1414

1515
FLAGS:

cmd/scw/testdata/test-all-usage-function-cron-delete-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete the cron associated with the given id.
3+
Delete the cron associated with the specified ID.
44

55
USAGE:
66
scw function cron delete <cron-id ...> [arg=value ...]
77

88
ARGS:
9-
cron-id
9+
cron-id UUID of the cron to delete
1010
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1111

1212
FLAGS:

cmd/scw/testdata/test-all-usage-function-cron-get-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get the cron associated with the given id.
3+
Get the cron associated with the specified ID.
44

55
USAGE:
66
scw function cron get <cron-id ...> [arg=value ...]
77

88
ARGS:
9-
cron-id
9+
cron-id UUID of the cron to get
1010
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1111

1212
FLAGS:

cmd/scw/testdata/test-all-usage-function-cron-list-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List all your crons.
3+
List all the cronjobs in a specified region.
44

55
USAGE:
66
scw function cron list [arg=value ...]
77

88
ARGS:
9-
[order-by] (created_at_asc | created_at_desc)
10-
[function-id]
9+
[order-by] Order of the crons (created_at_asc | created_at_desc)
10+
[function-id] UUID of the function
1111
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
1212

1313
FLAGS:

cmd/scw/testdata/test-all-usage-function-cron-update-usage.golden

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update the cron associated with the given id.
3+
Update the cron associated with the specified ID.
44

55
USAGE:
66
scw function cron update <cron-id ...> [arg=value ...]
77

88
ARGS:
9-
cron-id
10-
[function-id]
11-
[schedule]
12-
[args]
13-
[name]
9+
cron-id UUID of the cron to update
10+
[function-id] UUID of the function to use the cron with
11+
[schedule] Schedule of the cron in UNIX cron format
12+
[args] Arguments to use with the cron
13+
[name] Name of the cron
1414
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1515

1616
FLAGS:

cmd/scw/testdata/test-all-usage-function-cron-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ AVAILABLE COMMANDS:
99
create Create a new cron
1010
delete Delete an existing cron
1111
get Get a cron
12-
list List all your crons
12+
list List all crons
1313
update Update an existing cron
1414

1515
FLAGS:

cmd/scw/testdata/test-all-usage-function-domain-create-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a domain name binding.
3+
Create a domain name binding for the function with the specified ID.
44

55
USAGE:
66
scw function domain create [arg=value ...]
77

88
ARGS:
9-
[hostname]
10-
[function-id]
9+
[hostname] Hostame to create
10+
[function-id] UUID of the function to associate the domain with
1111
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1212

1313
FLAGS:

cmd/scw/testdata/test-all-usage-function-domain-delete-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete a domain name binding.
3+
Delete a domain name binding for the function with the specified ID.
44

55
USAGE:
66
scw function domain delete <domain-id ...> [arg=value ...]
77

88
ARGS:
9-
domain-id
9+
domain-id UUID of the domain to delete
1010
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1111

1212
FLAGS:

cmd/scw/testdata/test-all-usage-function-domain-get-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get a domain name binding.
3+
Get a domain name binding for the function with the specified ID.
44

55
USAGE:
66
scw function domain get <domain-id ...> [arg=value ...]
77

88
ARGS:
9-
domain-id
9+
domain-id UUID of the domain to get
1010
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1111

1212
FLAGS:

cmd/scw/testdata/test-all-usage-function-domain-list-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List all domain name bindings.
3+
List all domain name bindings in a specified region.
44

55
USAGE:
66
scw function domain list [arg=value ...]
77

88
ARGS:
9-
[order-by] (created_at_asc | created_at_desc | hostname_asc | hostname_desc)
10-
[function-id]
9+
[order-by] Order of the domains (created_at_asc | created_at_desc | hostname_asc | hostname_desc)
10+
[function-id] UUID of the function the domain is assoicated with
1111
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
1212

1313
FLAGS:

0 commit comments

Comments
 (0)