Skip to content

Commit 6d0d2f8

Browse files
authored
included odo yaml samples in devfile authoring docs (#53)
Co-authored-by: jc-berger <>
1 parent c038445 commit 6d0d2f8

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Adding a name to a devfile is mandatory. Both `name` and `generateName` are opti
1919
schemaVersion: 2.0.0
2020
metadata:
2121
name: devfile-sample
22+
version: 2.0.0
2223
----
2324

2425
. To specify a prefix for automatically generated workspace names, define the `generateName` attribute and don't define the `name` attribute. The workspace name will be in the `<generateName>YYYYY` format (for example, `devfile-sample-2y7kp`). `Y` is random `[a-z0-9]` character.
@@ -30,6 +31,7 @@ metadata:
3031
schemaVersion: 2.0.0
3132
metadata:
3233
name: devfile-sample
34+
version: 2.0.0
3335
----
3436

3537
[NOTE]

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ This section describes how to add one or more projects to a devfile.
2323
schemaVersion: 2.0.0
2424
metadata:
2525
name: petclinic-dev-environment
26+
version: 2.0.0
2627
projects:
2728
- name: petclinic
2829
git:
@@ -40,6 +41,7 @@ projects:
4041
schemaVersion: 2.0.0
4142
metadata:
4243
name: example-devfile
44+
version: 2.0.0
4345
projects:
4446
- name: frontend
4547
git:
@@ -96,6 +98,7 @@ source:
9698
schemaVersion: 2.0.0
9799
metadata:
98100
name: my-project-dev
101+
version: 2.0.0
99102
projects:
100103
- name: my-project-resource
101104
clonePath: resources/my-project

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,17 @@ The `schemaVersion` attribute is mandatory in a devfile.
1313
====
1414
[source,yaml]
1515
----
16+
v2.0
17+
---
1618
schemaVersion: 2.0.0
19+
metadata:
20+
name: devfile-sample
21+
version: 2.0.0
1722
----
1823
====
1924

2025

2126
[role="_additional-resources"]
2227
.Additional resources
2328

24-
* xref:api-reference.adoc[]
29+
* xref:api-reference.adoc[]

0 commit comments

Comments
 (0)