Skip to content

included odo yaml samples in devfile authoring docs #53

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 20, 2021
Merged

included odo yaml samples in devfile authoring docs #53

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: 2 additions & 0 deletions docs/modules/user-guide/partials/proc_adding-a-name-to-a-devfile.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Adding a name to a devfile is mandatory. Both `name` and `generateName` are opti
schemaVersion: 2.0.0
metadata:
name: devfile-sample
version: 2.0.0
----

. 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.
Expand All @@ -30,6 +31,7 @@ metadata:
schemaVersion: 2.0.0
metadata:
name: devfile-sample
version: 2.0.0
----

[NOTE]
Expand Down
3 changes: 3 additions & 0 deletions docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ This section describes how to add one or more projects to a devfile.
schemaVersion: 2.0.0
metadata:
name: petclinic-dev-environment
version: 2.0.0
projects:
- name: petclinic
git:
Expand All @@ -40,6 +41,7 @@ projects:
schemaVersion: 2.0.0
metadata:
name: example-devfile
version: 2.0.0
projects:
- name: frontend
git:
Expand Down Expand Up @@ -96,6 +98,7 @@ source:
schemaVersion: 2.0.0
metadata:
name: my-project-dev
version: 2.0.0
projects:
- name: my-project-resource
clonePath: resources/my-project
Expand Down
7 changes: 6 additions & 1 deletion docs/modules/user-guide/partials/proc_adding-schema-version-to-a-devfile.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,17 @@ The `schemaVersion` attribute is mandatory in a devfile.
====
[source,yaml]
----
v2.0
---
schemaVersion: 2.0.0
metadata:
name: devfile-sample
version: 2.0.0
----
====


[role="_additional-resources"]
.Additional resources

* xref:api-reference.adoc[]
* xref:api-reference.adoc[]