Skip to content

Commit 9650c41

Browse files
scaleway-botscaleway-bot
authored
docs(tem): revamp (#2942)
1 parent 0611b06 commit 9650c41

15 files changed

+139
-139
lines changed

‎cmd/scw/testdata/test-all-usage-tem-domain-check-usage.golden‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Ask for an immediate check of a domain (DNS check).
3+
Perform an immediate DNS check of a domain using the `region` and `domain_id` parameters.
44

55
USAGE:
66
scw tem domain check <domain-id ...> [arg=value ...]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Register a domain in a project.
3+
You must specify the `region`, `project_id` and `domain_name` to register a domain in a specific Project.
44

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

88
ARGS:
99
[project-id] Project ID to use. If none is passed the default project ID will be used
1010
[domain-name] Fully qualified domain dame
11-
[accept-tos] Accept the Scaleway Terms of Service
11+
[accept-tos] Accept Scaleway's Terms of Service
1212
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1313

1414
FLAGS:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get information about a domain.
3+
Retrieve information about a specific domain using the `region` and `domain_id` parameters.
44

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List domains in a project and/or in an organization.
3+
Retrieve domains in a specific project or in a specific Organization using the `region` parameter.
44

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

‎cmd/scw/testdata/test-all-usage-tem-domain-revoke-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-
Revoke a domain.
3+
You must specify the domain you want to delete by the `region` and `domain_id`. Deleting a domain is permanent and cannot be undone.
44

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

88
ARGS:
9-
domain-id ID of the domain to revoke
9+
domain-id ID 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)
1111

1212
FLAGS:

‎cmd/scw/testdata/test-all-usage-tem-domain-usage.golden‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ USAGE:
66
scw tem domain <command>
77

88
AVAILABLE COMMANDS:
9-
check Ask for an immediate check of a domain (DNS check)
9+
check Domain DNS check
1010
create Register a domain in a project
1111
get Get information about a domain
12-
list List domains in a project and/or in an organization
13-
revoke Revoke a domain
12+
list List domains
13+
revoke Delete a domain
1414

1515
FLAGS:
1616
-h, --help help for domain

‎cmd/scw/testdata/test-all-usage-tem-email-cancel-usage.golden‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Try to cancel an email if it has not yet been sent.
3+
You can cancel the sending of an email if it has not been sent yet. You must specify the `region` and the `email_id` of the email you want to cancel.
44

55
USAGE:
66
scw tem email cancel <email-id ...> [arg=value ...]

‎cmd/scw/testdata/test-all-usage-tem-email-create-usage.golden‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Send an email.
3+
You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain. The subject of the email must contain at least 6 characters.
44

55
USAGE:
66
scw tem email create [arg=value ...]
77

88
ARGS:
99
[from.email] Email address
10-
[from.name] Optional display name
10+
[from.name] (Optional) Name displayed
1111
[to.{index}.email] Email address
12-
[to.{index}.name] Optional display name
12+
[to.{index}.name] (Optional) Name displayed
1313
[cc.{index}.email] Email address
14-
[cc.{index}.name] Optional display name
14+
[cc.{index}.name] (Optional) Name displayed
1515
[bcc.{index}.email] Email address
16-
[bcc.{index}.name] Optional display name
17-
[subject] Message subject
16+
[bcc.{index}.name] (Optional) Name displayed
17+
[subject] Subject of the email
1818
[text] Text content
1919
[html] HTML content
2020
[project-id] Project ID to use. If none is passed the default project ID will be used
2121
[attachments.{index}.name] Filename of the attachment
22-
[attachments.{index}.type] MIME type of the attachment (Currently only allow, text files, pdf and html files)
23-
[attachments.{index}.content] Content of the attachment, encoded in base64
24-
[send-before] Maximum date to deliver mail
22+
[attachments.{index}.type] MIME type of the attachment
23+
[attachments.{index}.content] Content of the attachment encoded in base64
24+
[send-before] Maximum date to deliver the email
2525
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
2626

2727
FLAGS:

‎cmd/scw/testdata/test-all-usage-tem-email-get-statistics-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-
Get statistics on the email statuses.
3+
Get information on your emails' statuses.
44

55
USAGE:
66
scw tem email get-statistics [arg=value ...]
77

88
ARGS:
9-
[project-id] Optional, count emails for this project
10-
[domain-id] Optional, count emails send from this domain (must be coherent with the `project_id` and the `organization_id`)
11-
[since] Optional, count emails created after this date
12-
[until] Optional, count emails created before this date
13-
[mail-from] Optional, count emails sent with this `mail_from` sender's address
9+
[project-id] Number of emails for this Project (optional)
10+
[domain-id] Number of emails sent from this domain (must be coherent with the `project_id` and the `organization_id`) (optional)
11+
[since] Number of emails created after this date (optional)
12+
[until] Number of emails created before this date (optional)
13+
[mail-from] Number of emails sent with this `mail_from` sender's address (optional)
1414
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1515

1616
FLAGS:

‎cmd/scw/testdata/test-all-usage-tem-email-get-usage.golden‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get information about an email.
3+
Retrieve information about a specific email using the `email_id` and `region` parameters.
44

55
USAGE:
66
scw tem email get <email-id ...> [arg=value ...]

0 commit comments

Comments
 (0)