Skip to content

Commit dfc20b9

Browse files
jc-bergerbburt-rhmissmesss
authored
jcberger devwithdevfiles for2.1 (#131)
* added doc for how to develop with devfiles * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Brian Burt <[email protected]> * applied doc feedback to make instructions consistent and expand prereqs * addressed dev review for prereqs and instructions * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Olga Tikhomirova <[email protected]> * Update docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc Co-authored-by: Olga Tikhomirova <[email protected]> * removed unnecessary step in procedure * changed prereqs and tightened procedure steps * cherry picked developing with devfiles into 2.1 Co-authored-by: jc-berger <> Co-authored-by: Brian Burt <[email protected]> Co-authored-by: Olga Tikhomirova <[email protected]>
1 parent cc233be commit dfc20b9

File tree

4 files changed

+43
-1
lines changed

4 files changed

+43
-1
lines changed

docs/modules/user-guide/attachments/api-reference/2.1.0/main.css.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/modules/user-guide/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
* xref:index.adoc[]
22
33
* Developer
4+
** xref:developing-with-devfiles.adoc[]
45
** xref:using-devfiles.adoc[]
56
*** xref:adding-schema-version-to-a-devfile.adoc[]
67
*** xref:adding-a-name-to-a-devfile.adoc[]
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:description: Developing with devfiles
2+
:navtitle: Developing with devfiles
3+
:keywords: developing, devfiles
4+
5+
include::partial$proc_developing-with-devfiles.adoc[]
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
[id="proc_developing-with-devfiles_{context}"]
2+
= Developing with devfiles
3+
[role="_abstract"]
4+
5+
Use the devfile specification to develop a Node.js “Hello World” application. Developing this application introduces you to how a devfile automates and simplifies your development process.
6+
7+
.Prerequisites
8+
9+
To make developing with the devfile specification easier, consider doing the following:
10+
11+
* Install link:https://minikube.sigs.k8s.io/docs/start/[minikube] to create a Kubernetes cluster on your local machine.
12+
* Download link:https://kubernetes.io/docs/tasks/tools/install-kubectl-macos/[kubectl] to access your namespace.
13+
* Enable link:https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/[ingress on minikube] to access your devfile project.
14+
* Install the link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.6/html/cli_tools/developer-cli-odo#installing-odo[odo command line interface (CLI) tool] to execute the devfile specification.
15+
16+
.Procedure
17+
18+
. View the available devfiles:
19+
+
20+
----
21+
$ odo catalog list components
22+
----
23+
. Run `odo create nodejs _<name of your project>_ --starter` to create a devfile project.
24+
* Add the `--starter` parameter to include the starter project currently inside the Node.js devfile specification, which makes it easier for you to develop an application.
25+
. Run `minikube IP` to find your cluster IP address.
26+
. Run `odo url create _<name you give the url>_ --ingress --host _<IP address>_.nip.io`. Doing so creates an ingress inside your cluster that you can use to access your application using the cluster IP address.
27+
* Example: `odo url create myfirstproject --ingress --host 192.168.64.2.nip.io`.
28+
. Run `odo push` to build the URL.
29+
30+
.Verification
31+
32+
* To verify that you built your Node.js "Hello World" application successfully, view the application in a web browser by copying and pasting the URL that was produced by running the `odo push` command. Go to the URL and view your "Hello World" application.
33+
34+
.Additional resources
35+
36+
To continue working with devfiles, go to xref:authoring-devfiles.adoc[Authoring devfiles].

0 commit comments

Comments
 (0)