Skip to content

Commit 72d2042

Browse files
committed
fix descriptions
CloudShell doesn't show description if there is a " in the description
1 parent bece21a commit 72d2042

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

shell-definition.yaml

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ node_types:
2020
Region:
2121
type: string
2222
default: ""
23-
description: 'The code of the AWS region to be used by this cloud provider
24-
resource. For example, "us-east-1".'
23+
description: "The code of the AWS region to be used by this cloud provider
24+
resource. For example, 'us-east-1'."
2525
constraints:
2626
- valid_values:
2727
- us-east-1
@@ -38,53 +38,53 @@ node_types:
3838
type: string
3939
default: ""
4040
description: "The Management VPC's security group (use the SG1id output when
41-
configuring the Management VPC for the region). For example, \"sg-71240198\".
41+
configuring the Management VPC for the region). For example, 'sg-71240198'.
4242
This value is used by the Setup process to configure the communication between
4343
the Management VPC's instances and the Sandbox instances."
4444
AWS Mgmt VPC ID:
4545
type: string
4646
default: ""
47-
description: 'ID of the Management VPC. Used by the Setup process to set up the
47+
description: "ID of the Management VPC. Used by the Setup process to set up the
4848
VPC and subnet for the sandbox (use the ManagementVPCID output when configuring
49-
the Management VPC for the region). For example vpc-633fb904. This value is
50-
created when configuring the Management VPC for the region.'
49+
the Management VPC for the region). For example 'vpc-633fb904'. This value is
50+
created when configuring the Management VPC for the region."
5151
Keypairs Location:
5252
type: string
5353
default: ""
54-
description: 'S3 bucket containing sandbox PEM files (use the S3Name output when
54+
description: "S3 bucket containing sandbox PEM files (use the S3Name output when
5555
configuring the Management VPC for the region). Each active Sandbox creates a
56-
PEM file under a designated folder. For example, "sandbox-management".'
56+
PEM file under a designated folder. For example, 'sandbox-management'."
5757
Max Storage Size:
5858
type: integer
5959
default: 0
60-
description: '(Optional) The maximum number of GiB in the root volume. The value
60+
description: "(Optional) The maximum number of GiB in the root volume. The value
6161
of this parameter will be the storage size limit for all apps deployed on this
62-
Cloud Provider. For example, "8". The value must be greater than or equal to the
63-
size of the root snapshot used. If set to "0", the default size of the snapshot
64-
will be used.'
62+
Cloud Provider. For example, '8'. The value must be greater than or equal to the
63+
size of the root snapshot used. If set to '0', the default size of the snapshot
64+
will be used."
6565
Max Storage IOPS:
6666
type: integer
6767
default: 0
68-
description: '(Optional) The maximum number of I/O operations per second to be
68+
description: "(Optional) The maximum number of I/O operations per second to be
6969
supported by the volume. The value of this parameter will be the storage IOPS
70-
limit for all apps deployed on this Cloud Provider. For example, "240". This
70+
limit for all apps deployed on this Cloud Provider. For example, '240'. This
7171
parameter is used only for storage of type io1, in which you can provision up to
72-
30 IOPS per GiB. If set to zero, the default in the image is used.'
72+
30 IOPS per GiB. If set to zero, the default in the image is used."
7373
Networks in use:
7474
type: string
7575
default: ""
76-
description: 'Reserved networks that will be excluded when allocating sandbox
76+
description: "Reserved networks that will be excluded when allocating sandbox
7777
networks, and therefore must include the Management VPC CIDR (which was provided
7878
as an input to the CloudFormation deployment process) as well as any other
7979
private networks that have access to the Management VPC. The syntax is comma
80-
separated CIDR, only of size "/24". For example, "10.0.0.0/24,172.31.0.0/24".'
80+
separated CIDR, only of size '/24'. For example, '10.0.0.0/24,172.31.0.0/24'."
8181
Instance Type:
8282
type: string
8383
default: ""
84-
description: '(Optional) The default AWS EC2 instance type for the deployed
84+
description: "(Optional) The default AWS EC2 instance type for the deployed
8585
instance. The instance type determines the CPU, memory and networking capacity
86-
of the instance to be deployed. For example t2.large. The instance type can be
87-
changed when creating the App in the Manage dashboard.'
86+
of the instance to be deployed. For example 't2.large'. The instance type can be
87+
changed when creating the App in the Manage dashboard."
8888
VPC Mode:
8989
type: string
9090
default: "Dynamic"
@@ -110,7 +110,7 @@ node_types:
110110
default: ""
111111
description: "(Mandatory for Shared VPC mode) Shared VPC's ID (can be found in
112112
the output of the shared VPC CloudFormation stack, in the SharedVPCId key).
113-
For example: \"vpc-0bf24b1ebrd855e30\"."
113+
For example: 'vpc-0bf24b1ebrd855e30'."
114114
Shared VPC Role Arn:
115115
type: string
116116
default: ""
@@ -136,10 +136,10 @@ node_types:
136136
Additional Management Networks:
137137
type: string
138138
default: ""
139-
description: 'Networks to be allowed to interact with all sandboxes. This is
139+
description: "Networks to be allowed to interact with all sandboxes. This is
140140
used for allowing connectivity to AWS resources outside the Management VPC.
141141
The syntax is comma separated CIDRs.
142-
For example, "10.0.0.0/24,10.1.0.0/16,172.31.0.0/24".'
142+
For example, '10.0.0.0/24,10.1.0.0/16,172.31.0.0/24'."
143143
VPN Gateway ID:
144144
type: string
145145
default: ""
@@ -178,8 +178,8 @@ node_types:
178178
Region:
179179
type: string
180180
default: ""
181-
description: 'The code of the AWS region to be used by this cloud provider
182-
resource. For example, "us-east-1".'
181+
description: "The code of the AWS region to be used by this cloud provider
182+
resource. For example, 'us-east-1'."
183183
constraints:
184184
- valid_values:
185185
- us-east-1
@@ -196,56 +196,56 @@ node_types:
196196
type: string
197197
default: ""
198198
description: "The Management VPC's security group (use the SG1id output when
199-
configuring the Management VPC for the region). For example, \"sg-71240198\".
199+
configuring the Management VPC for the region). For example, 'sg-71240198'.
200200
This value is used by the Setup process to configure the communication between
201201
the Management VPC's instances and the Sandbox instances."
202202
AWS Mgmt VPC ID:
203203
type: string
204204
default: ""
205-
description: 'ID of the Management VPC. Used by the Setup process to set up
205+
description: "ID of the Management VPC. Used by the Setup process to set up
206206
the VPC and subnet for the sandbox (use the ManagementVPCID output when
207-
configuring the Management VPC for the region). For example vpc-633fb904.
208-
This value is created when configuring the Management VPC for the region.'
207+
configuring the Management VPC for the region). For example 'vpc-633fb904'.
208+
This value is created when configuring the Management VPC for the region."
209209
Keypairs Location:
210210
type: string
211211
default: ""
212-
description: 'S3 bucket containing sandbox PEM files (use the S3Name output
212+
description: "S3 bucket containing sandbox PEM files (use the S3Name output
213213
when configuring the Management VPC for the region). Each active Sandbox
214214
creates a PEM file under a designated folder. For example,
215-
"sandbox-management".'
215+
'sandbox-management'."
216216
Max Storage Size:
217217
type: integer
218218
default: 0
219-
description: '(Optional) The maximum number of GiB in the root volume. The
219+
description: "(Optional) The maximum number of GiB in the root volume. The
220220
value of this parameter will be the storage size limit for all apps deployed
221-
on this Cloud Provider. For example, "8". The value must be greater than or
222-
equal to the size of the root snapshot used. If set to "0", the default size
223-
of the snapshot will be used.'
221+
on this Cloud Provider. For example, '8'. The value must be greater than or
222+
equal to the size of the root snapshot used. If set to '0', the default size
223+
of the snapshot will be used."
224224
Max Storage IOPS:
225225
type: integer
226226
default: 0
227-
description: '(Optional) The maximum number of I/O operations per second to
227+
description: "(Optional) The maximum number of I/O operations per second to
228228
be supported by the volume. The value of this parameter will be the storage
229-
IOPS limit for all apps deployed on this Cloud Provider. For example, "240".
229+
IOPS limit for all apps deployed on this Cloud Provider. For example, '240'.
230230
This parameter is used only for storage of type io1, in which you can
231231
provision up to 30 IOPS per GiB. If set to zero, the default in the image is
232-
used.'
232+
used."
233233
Networks in use:
234234
type: string
235235
default: ""
236-
description: 'Reserved networks that will be excluded when allocating
236+
description: "Reserved networks that will be excluded when allocating
237237
sandbox networks, and therefore must include the Management VPC CIDR (which
238238
was provided as an input to the CloudFormation deployment process) as well
239239
as any other private networks that have access to the Management VPC. The
240-
syntax is comma separated CIDR, only of size "/24". For example,
241-
"10.0.0.0/24,172.31.0.0/24".'
240+
syntax is comma separated CIDR, only of size '/24'. For example,
241+
'10.0.0.0/24,172.31.0.0/24'."
242242
Instance Type:
243243
type: string
244244
default: ""
245-
description: '(Optional) The default AWS EC2 instance type for the deployed
245+
description: "(Optional) The default AWS EC2 instance type for the deployed
246246
instance. The instance type determines the CPU, memory and networking
247247
capacity of the instance to be deployed. For example “t2.large”. The
248-
instance type can be changed when creating the App in the Manage dashboard.'
248+
instance type can be changed when creating the App in the Manage dashboard."
249249
VPC Mode:
250250
type: string
251251
default: "Dynamic"
@@ -273,7 +273,7 @@ node_types:
273273
default: ""
274274
description: "(Mandatory for Shared VPC mode) Shared VPC's ID (can be found
275275
in the output of the shared VPC CloudFormation stack, in the SharedVPCId
276-
key). For example: \"vpc-0bf24b1ebrd855e30\"."
276+
key). For example: 'vpc-0bf24b1ebrd855e30'."
277277
Shared VPC Role Arn:
278278
type: string
279279
default: ""
@@ -291,10 +291,10 @@ node_types:
291291
Additional Management Networks:
292292
type: string
293293
default: ""
294-
description: 'Networks to be allowed to interact with all sandboxes. This is
294+
description: "Networks to be allowed to interact with all sandboxes. This is
295295
used for allowing connectivity to AWS resources outside the Management VPC.
296296
The syntax is comma separated CIDRs.
297-
For example, "10.0.0.0/24,10.1.0.0/16,172.31.0.0/24".'
297+
For example, '10.0.0.0/24,10.1.0.0/16,172.31.0.0/24'."
298298
VPN Gateway ID:
299299
type: string
300300
default: ""

0 commit comments

Comments
 (0)