Skip to content

Commit 18d50a6

Browse files
jc-bergerelsony
jc-berger
authored andcommitted
included odo lists throughout authoring stack docs
1 parent 03561c4 commit 18d50a6

6 files changed

+40
-6
lines changed

docs/modules/user-guide/partials/proc_adding-a-name-to-a-devfile.adoc

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22
= Adding a name to a devfile
33

44
[role="_abstract"]
5-
Adding a name to a devfile is mandatory. Use the `name` or `generateName` attributes (or both) to define the name.
5+
Adding a name to a devfile is mandatory. Use the `name` or `generateName` attributes to define the name. See the following list for metadata properties in a devfile:
6+
7+
[horizontal]
8+
Key:: metadataObject
9+
Type:: metadataObject
10+
Required:: no
11+
Description:: metadata to be used
612

713
.Prerequisites
814

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22
= Adding commands to a devfile
33

44
[role="_abstract"]
5-
A devfile allows to specify commands to be available for execution in a workspace. Every command can contain a subset of actions. These subsets are related to specific components and are executed in the component containers.
5+
A devfile allows to specify commands to be available for execution in a workspace. Every command can contain a subset of actions. These subsets are related to specific components and are executed in the component containers. See the following list for command properties in a devfile:
6+
7+
[horizontal]
8+
Key:: commandObject
9+
Type:: commandObject
10+
Required:: no
11+
Description:: command to be executed in an existing component container
612

713
.Prerequisites
814

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

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

44
[role="_abstract"]
5-
Each component in a single devfile must have a unique name.
5+
Each component in a single devfile must have a unique name. See the following list for component properties in a devfile:
6+
7+
[horizontal]
8+
Key:: componentObject
9+
Type:: componentObject
10+
Required:: no
11+
Description:: list of components to be used
612

713
.Prerequisites
814

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
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.
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. See the following list for event properties in a devfile:
6+
7+
[horizontal]
8+
Key:: eventObject
9+
Type:: eventObject
10+
Required:: no
11+
Description:: events to be executed during a project lifecycle
612

713
.Procedure
814

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22
= Adding projects to a devfile
33

44
[role="_abstract"]
5-
This section describes how to add one or more projects to a devfile.
5+
This section describes how to add one or more projects to a devfile. See the following list for project properties in a devfile:
66

7+
[horizontal]
8+
Key:: starterProjectObject
9+
Type:: starterProjectObject
10+
Required:: no
11+
Description:: list of starter projects to be used
712

813
.Prerequisites
914

docs/modules/user-guide/partials/proc_adding-schema-version-to-a-devfile.adoc

+6-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22
= Adding schema version to a devfile
33

44
[role="_abstract"]
5-
The `schemaVersion` attribute is mandatory in a devfile.
5+
The `schemaVersion` attribute is mandatory in a devfile. See the following list for `schemaVersion` properties in a devfile:
66

7+
[horizontal]
8+
Key:: schemaVersion
9+
Type:: string
10+
Required:: yes
11+
Description:: v2.1.0 of the schema
712

813
.Procedure
914

0 commit comments

Comments
 (0)