Skip to content

Commit adac3e8

Browse files
authored
created a more thorough overview for devfiles (#28)
minor changes to sentence structure changed sentence structure added context to additional sources and who can use devfiles added more context improved grammar and removed passive voice and noise removed unneeded period Co-authored-by: jc-berger <>
1 parent 284f749 commit adac3e8

File tree

1 file changed

+30
-7
lines changed

1 file changed

+30
-7
lines changed

docs/modules/user-guide/partials/con_devfile.adoc

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,38 @@
33

44
[role="_abstract"]
55

6-
A devfile describes and defines a cloud native development environment.
6+
Devfiles are YAML files that describe and define developer workspaces or cloud-native development environments. Devfiles also describe best practices for end-to-end application development and customize or extend the application development to fit a team's current development practices. Instead of forcing a new workflow or tools, devfiles provide instructions for automating manual processes.
77

8-
Devfiles are consumed by tools that transform the definition into a cloud workspace composed of multiple cloud native resources. Any number of identical workspaces can be created from the same devfile. They can be shared in various ways including a devfile registry or together with the source code of a project.
8+
Development tools consume devfiles and transform the definition into a cloud workspace composed of multiple containers and cloud-native resources. Also, users can create any number of identical workspaces from the same devfile. This way, different teams can use and share workspaces in various ways, including a devfile registry or together with the source code of a project.
99

10+
A devfile includes:
11+
12+
* Guidance about runtime images
13+
* Example code
14+
* Build and CI commands
15+
* Deployment options
16+
17+
Benefits of devfiles:
18+
19+
* Reducing the gap between development and deployment
20+
* Having a registry for finding and hosting devfiles
21+
* Producing consistent build and run behaviors
22+
* Allowing easy devfile customization
23+
24+
.Who can use devfiles?
25+
26+
Stack providers use devfiles to develop their runtime stacks once and then use these runtime stacks across different tools. Therefore, with devfiles, stack providers do not need to build and maintain custom development tools.
27+
28+
Tool providers use devfiles to build runtime support for each runtime. Now, the devfile runtime teams build and run applications on their servers, giving tool providers more time.
29+
30+
Developers use devfiles to focus only on developing their applications. With devfiles, developers do not need to set up the environment for building and running their applications. Instead, developers have the flexibility to use different tools, like Che and odo.
1031

11-
[role="_additional-resources"]
1232
.Additional resources
1333

14-
* xref:api-reference.adoc[]
15-
* xref:authoring-stacks.adoc[]
16-
* xref:migrating-to-devfile-v2.adoc[]
17-
* xref:devfile-samples.adoc[]
34+
[role="_additional-resources"]
35+
36+
* Example tool: link:https://developers.redhat.com/products/odo/overview[odo]
37+
* Devfile terminologies: xref:api-reference.adoc[]
38+
* Work with devfiles: xref:authoring-stacks.adoc[]
39+
* Update devfiles: xref:migrating-to-devfile-v2.adoc[]
40+
* Learn more about devfiles: xref:devfile-samples.adoc[]

0 commit comments

Comments
 (0)