Skip to content

Commit 438c48e

Browse files
jc-bergerelsony
jc-berger
authored andcommitted
more SME feedback
1 parent 138161c commit 438c48e

4 files changed

+10
-57
lines changed

Diff for: docs/modules/user-guide/partials/proc_adding-commands-to-a-devfile.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ A devfile allows you to specify commands to be available for execution in a work
7474
|commands
7575
|string
7676
|no
77-
|The exec commands that constitute the composite command.
77+
|The exec commands that constitute the composite command and chains multiple commands together.
7878

7979
|parallel
8080
|boolean
@@ -106,7 +106,7 @@ A devfile allows you to specify commands to be available for execution in a work
106106
|boolean
107107
|no
108108
|Identifies if it is the default command to run. Only one default command can be defined for each group.
109-
|===
109+
|===
110110

111111
.Prerequisites
112112

Diff for: docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Adding components to a devfile
33

44
[role="_abstract"]
5-
Each component in a single devfile must have a unique name and use the `container` object. See the following tables for component properties in a devfile:
5+
Each component in a single devfile must have a unique name and use one of the objects: `container`, `kubernetes`, `openshift`, or `volume`. See the following tables for component properties in a devfile:
66

77
.Component object
88
[cols="1,1,1,1"]
@@ -79,7 +79,7 @@ Each component in a single devfile must have a unique name and use the `containe
7979
|exposure
8080
|string
8181
|no
82-
|Use the following attributes to describe how to expose the endpoints on the network: `public`, `internal`, `none`.
82+
|Use the following attributes to describe how to expose the endpoints on the network: `public`, `internal`, `none`. If not specified, the default attribute is `public`.
8383

8484
|path
8585
|string
@@ -89,7 +89,7 @@ Each component in a single devfile must have a unique name and use the `containe
8989
|protocol
9090
|string
9191
|no
92-
|Use the following attributes to describe the application and transport protocols of the traffic that goes through the endpoint: `http`, `https`, `ws`, `wss`, `tcp`, `udp`.
92+
|Use the following attributes to describe the application and transport protocols of the traffic that goes through the endpoint: `http`, `https`, `ws`, `wss`, `tcp`, `udp`. If not specified, the default attribute is `public`.
9393

9494
|secure
9595
|boolean

Diff for: docs/modules/user-guide/partials/proc_adding-event-bindings.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Adding event bindings
33

44
[role="_abstract"]
5-
This section describes how to add an event to a v2.x devfile. An event specified in a v1.x devfile still works in a v2.x devfile. An event can have three different type of objects:
5+
This section describes how to add an event to a v2.x devfile. An event can have three different type of objects:
66

77
. preStartObject
88
. postStartObject

Diff for: docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc

+4-51
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,7 @@
22
= Adding projects to a devfile
33

44
[role="_abstract"]
5-
This section describes how to add one or more projects to a devfile. Each starter project can contain three different objects:
6-
7-
* git
8-
* github
9-
* zip
10-
11-
See the following tables for project properties in a devfile:
5+
This section describes how to add one or more projects to a devfile. Each starter project can contain either a `git` or `zip` object. See the following tables for project properties in a devfile:
126

137
.starterProject object
148
[cols="1,1,1,1"]
@@ -17,7 +11,7 @@ See the following tables for project properties in a devfile:
1711

1812
|name
1913
|string
20-
|no
14+
|yes
2115
|The name of your devfile.
2216

2317
|description
@@ -37,51 +31,15 @@ See the following tables for project properties in a devfile:
3731
|===
3832
|Key |Type| Required| Description
3933

40-
|location
34+
|checkoutFrom
4135
|string
4236
|no
4337
|The location of your git repository.
4438

45-
|branch
39+
|remotes
4640
|string
4741
|no
4842
|The branch that you use.
49-
50-
|spareCheckoutDir
51-
|string
52-
|no
53-
|The directory that you use when you pull from your repository.
54-
55-
|startPoint
56-
|string
57-
|no
58-
|The tag or commit from where you start.
59-
|===
60-
61-
.githubObject
62-
[cols="1,1,1,1"]
63-
|===
64-
|Key |Type| Required| Description
65-
66-
|location
67-
|string
68-
|no
69-
|The location of your git repository.
70-
71-
|branch
72-
|string
73-
|no
74-
|The branch that you use.
75-
76-
|spareCheckoutDir
77-
|string
78-
|no
79-
|The directory that you use when you pull from your repository.
80-
81-
|startPoint
82-
|string
83-
|no
84-
|The tag or commit from where you start.
8543
|===
8644

8745
.zipObject
@@ -93,11 +51,6 @@ See the following tables for project properties in a devfile:
9351
|string
9452
|no
9553
|The location of your zip.
96-
97-
|spareCheckoutDir
98-
|string
99-
|no
100-
|The directory that you use when you pull from your repository.
10154
|===
10255

10356
.Prerequisites

0 commit comments

Comments
 (0)