Skip to content
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.

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

fix: Follow latest devfile 2 specification #2175

Merged
merged 2 commits into from
Dec 3, 2021
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
:parent-context-of-authoring-devfiles-version-2: {context}

[id="authoring-devfiles-version-2_{context}"]
= Authoring a devfile 2.0.0
= Authoring a devfile 2
//a new attribute to be considered for supported devfile version specification for when all three assemblies on the topic of authoring a devfile are rewritten. max-cx

:context: authoring-devfiles-version-2

When you author or edit a devfile for configuring a workspace, the devfile must meet the devfile 2.0.0 specification.
When you author or edit a devfile for configuring a workspace, the devfile must meet the latest devfile 2 specification.

.Prerequisites
* An instance of {prod-short} with the xref:installation-guide:enabling-dev-workspace-engine.adoc[DevWorkspace Operator] enabled. See xref:installation-guide:installing-che.adoc[Installing {prod-short}].

.Procedure
//TODO - Figure out whether we want to duplicate, single source or just reference devfile docs here

* Follow the instructions in the link:https://devfile.io/docs/devfile/2.0.0/user-guide/authoring-stacks.html[Devfile User Guide].

.Additional resources

* For more information about devfile object schema and object properties, see the link:https://redhat-developer.github.io/devfile/devfile[Introduction to Devfiles].
//To note, the page linked to on the preceeding line discusses devfile 1.0.0, which readers here might find confusing. max-cx

:context: {parent-context-of-authoring-devfiles-version-2}
:context: {parent-context-of-authoring-devfiles-version-2}