Skip to content

docs(instance): modifs to instance doc for new developers site #3078

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 24, 2023
Merged

docs(instance): modifs to instance doc for new developers site #3078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-instance-security-group-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ARGS:
[stateful=true] Whether the security group is stateful or not
[inbound-default-policy=accept] Default policy for inbound rules (accept | drop)
[outbound-default-policy=accept] Default policy for outbound rules (accept | drop)
[enable-default-security] True to block SMTP on IPv4 and IPv6
[enable-default-security] True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)

Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-instance-volume-type-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:
scw instance volume-type <command>

AVAILABLE COMMANDS:
list List volumes types
list List volume types

FLAGS:
-h, --help help for volume-type
Expand Down
6 changes: 3 additions & 3 deletions docs/commands/instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Instance API.
- [List volumes](#list-volumes)
- [Update a volume](#update-a-volume)
- [Volume type management commands](#volume-type-management-commands)
- [List volumes types](#list-volumes-types)
- [List volume types](#list-volume-types)


## Image management commands
Expand Down Expand Up @@ -1137,7 +1137,7 @@ scw instance security-group create [arg=value ...]
| stateful | Default: `true` | Whether the security group is stateful or not |
| inbound-default-policy | Default: `accept`<br />One of: `accept`, `drop` | Default policy for inbound rules |
| outbound-default-policy | Default: `accept`<br />One of: `accept`, `drop` | Default policy for outbound rules |
| enable-default-security | | True to block SMTP on IPv4 and IPv6 |
| enable-default-security | | True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable |
| organization-id | | Organization ID to use. If none is passed the default organization ID will be used |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |

Expand Down Expand Up @@ -2905,7 +2905,7 @@ Each of these types will contains all the capabilities and constraints of the vo



### List volumes types
### List volume types

List all volume types and their technical details.

Expand Down
4 changes: 2 additions & 2 deletions internal/namespaces/instance/v1/instance_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ func instanceServerTypeList() *core.Command {

func instanceVolumeTypeList() *core.Command {
return &core.Command{
Short: `List volumes types`,
Short: `List volume types`,
Long: `List all volume types and their technical details.`,
Namespace: "instance",
Resource: "volume-type",
Expand Down Expand Up @@ -2044,7 +2044,7 @@ func instanceSecurityGroupCreate() *core.Command {
},
{
Name: "enable-default-security",
Short: `True to block SMTP on IPv4 and IPv6`,
Short: `True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down