Skip to content

Commit 800c15f

Browse files
scaleway-botscaleway-bot
authored
docs(webhosting): fix webhosting docs for new site (#3108)
1 parent 1c467ba commit 800c15f

16 files changed

+128
-132
lines changed

‎cmd/scw/testdata/test-all-usage-webhosting-hosting-create-usage.golden‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a hosting.
3+
Order a Web Hosting plan, specifying the offer type required via the `offer_id` parameter.
44

55
USAGE:
66
scw webhosting hosting create [arg=value ...]
77

88
ARGS:
9-
[offer-id] ID of the selected offer for the hosting
9+
[offer-id] ID of the selected offer for the Web Hosting plan
1010
[project-id] Project ID to use. If none is passed the default project ID will be used
11-
[email] Contact email of the client for the hosting
12-
[tags.{index}] The tags of the hosting
13-
[domain] The domain name of the hosting
14-
[option-ids.{index}] IDs of the selected options for the hosting
11+
[email] Contact email for the Web Hosting client
12+
[tags.{index}] List of tags for the Web Hosting plan
13+
[domain] Domain name to link to the Web Hosting plan. You must already own this domain name, and have completed the DNS validation process beforehand
14+
[option-ids.{index}] IDs of any selected additional options for the Web Hosting plan
1515
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
1616

1717
FLAGS:

‎cmd/scw/testdata/test-all-usage-webhosting-hosting-delete-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-
Delete a hosting with the given ID.
3+
Delete a Web Hosting plan, specified by its `hosting_id`. Note that deletion is not immediate: it will take place at the end of the calendar month, after which time your Web Hosting plan and all its data (files and emails) will be irreversibly lost.
44

55
USAGE:
66
scw webhosting hosting delete [arg=value ...]

‎cmd/scw/testdata/test-all-usage-webhosting-hosting-get-dns-records-usage.golden‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
The set of DNS record of a specific domain associated to a hosting.
3+
Get the set of DNS records of a specified domain associated with a Web Hosting plan.
44

55
USAGE:
66
scw webhosting hosting get-dns-records [arg=value ...]
@@ -10,7 +10,7 @@ EXAMPLES:
1010
scw webhosting hosting get-dns-records domain=foo.com
1111

1212
ARGS:
13-
domain Domain associated to the DNS records
13+
domain Domain associated with the DNS records
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-webhosting-hosting-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 the details of a Hosting with the given ID.
3+
Get the details of one of your existing Web Hosting plans, specified by its `hosting_id`.
44

55
USAGE:
66
scw webhosting hosting get [arg=value ...]

‎cmd/scw/testdata/test-all-usage-webhosting-hosting-list-usage.golden‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List all hostings.
3+
List all of your existing Web Hosting plans. Various filters are available to limit the results, including filtering by domain, status, tag and Project ID.
44

55
USAGE:
66
scw webhosting hosting list [arg=value ...]
@@ -10,12 +10,12 @@ EXAMPLES:
1010
scw webhosting hosting list project-id=a3244331-5d32-4e36-9bf9-b60233e201c7 organization-id=a3244331-5d32-4e36-9bf9-b60233e201c7
1111

1212
ARGS:
13-
[order-by] Define the order of the returned hostings (created_at_asc | created_at_desc)
14-
[tags.{index}] Return hostings with these tags
15-
[statuses.{index}] Return hostings with these statuses (unknown_status | delivering | ready | deleting | error | locked)
16-
[domain] Return hostings with this domain
17-
[project-id] Return hostings from this project ID
18-
[organization-id] Return hostings from this organization ID
13+
[order-by] Sort order for Web Hosting plans in the response (created_at_asc | created_at_desc)
14+
[tags.{index}] Tags to filter for, only Web Hosting plans with matching tags will be returned
15+
[statuses.{index}] Statuses to filter for, only Web Hosting plans with matching statuses will be returned (unknown_status | delivering | ready | deleting | error | locked)
16+
[domain] Domain to filter for, only Web Hosting plans associated with this domain will be returned
17+
[project-id] Project ID to filter for, only Web Hosting plans from this Project will be returned
18+
[organization-id] Organization ID to filter for, only Web Hosting plans from this Organization will be returned
1919
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)
2020

2121
FLAGS:

‎cmd/scw/testdata/test-all-usage-webhosting-hosting-restore-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-
Restore a hosting with the given ID.
3+
When you [delete a Web Hosting plan](#path-hostings-delete-a-hosting), definitive deletion does not take place until the end of the calendar month. In the time between initiating the deletion, and definitive deletion at the end of the month, you can choose to **restore** the Web Hosting plan, using this endpoint and specifying its `hosting_id`.
44

55
USAGE:
66
scw webhosting hosting restore [arg=value ...]

‎cmd/scw/testdata/test-all-usage-webhosting-hosting-update-usage.golden‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update a hosting.
3+
Update the details of one of your existing Web Hosting plans, specified by its `hosting_id`. You can update parameters including the contact email address, tags, options and offer.
44

55
USAGE:
66
scw webhosting hosting update [arg=value ...]
@@ -17,10 +17,10 @@ EXAMPLES:
1717

1818
ARGS:
1919
hosting-id Hosting ID
20-
[email] New contact email for the hosting
21-
[tags.{index}] New tags for the hosting
22-
[option-ids.{index}] New options IDs for the hosting
23-
[offer-id] New offer ID for the hosting
20+
[email] New contact email for the Web Hosting plan
21+
[tags.{index}] New tags for the Web Hosting plan
22+
[option-ids.{index}] IDs of the new options for the Web Hosting plan
23+
[offer-id] ID of the new offer for the Web Hosting plan
2424
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
2525

2626
FLAGS:

‎cmd/scw/testdata/test-all-usage-webhosting-hosting-usage.golden‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
A Scaleway web hosting associated with a domain name.
3+
With a Scaleway Web Hosting plan, you can manage your domain, configure your web hosting services, manage your emails and more. Create, list, update and delete your Web Hosting plans with these calls.
44

55
USAGE:
66
scw webhosting hosting <command>
77

88
AVAILABLE COMMANDS:
9-
create Create a hosting
10-
delete Delete a hosting
11-
get Get a hosting
12-
get-dns-records Get the DNS records
13-
list List all hostings
14-
restore Restore a hosting
15-
update Update a hosting
9+
create Order a Web Hosting plan
10+
delete Delete a Web Hosting plan
11+
get Get a Web Hosting plan
12+
get-dns-records Get DNS records
13+
list List all Web Hosting plans
14+
restore Restore a Web Hosting plan
15+
update Update a Web Hosting plan
1616

1717
FLAGS:
1818
-h, --help help for hosting

‎cmd/scw/testdata/test-all-usage-webhosting-offer-list-usage.golden‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List all offers.
3+
List the different Web Hosting offers, and their options, available to order from Scaleway.
44

55
USAGE:
66
scw webhosting offer list [arg=value ...]
@@ -16,10 +16,10 @@ EXAMPLES:
1616
scw webhosting offer list only-options=true
1717

1818
ARGS:
19-
[order-by] Define the order of the returned hostings (price_asc)
20-
[without-options] Select only offers, no options
21-
[only-options] Select only options
22-
[hosting-id] Define a specific hosting id (optional)
19+
[order-by] Sort order of offers in the response (price_asc)
20+
[without-options] Defines whether the response should consist of offers only, without options
21+
[only-options] Defines whether the response should consist of options only, without offers
22+
[hosting-id] ID of a Web Hosting plan, to check compatibility with returned offers (in case of wanting to update the plan)
2323
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
2424

2525
FLAGS:

‎cmd/scw/testdata/test-all-usage-webhosting-offer-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-
A hosting offer, with a set of features, available for purchase.
3+
Web Hosting offers represent the different types of Web Hosting plan available to order at Scaleway.
44

55
USAGE:
66
scw webhosting offer <command>

0 commit comments

Comments
 (0)