-
Notifications
You must be signed in to change notification settings - Fork 32
added doc for how to develop with devfiles #119
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
Merged
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
fc93668
added doc for how to develop with devfiles
2573f64
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger cd46b8f
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 9e30275
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 0137579
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger b2feb0a
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 4ae221c
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 23c8cac
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 4802e23
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 475bc69
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger ba8aaef
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 85f6a8e
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 49cec91
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 262b827
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 4d2df50
applied doc feedback to make instructions consistent and expand prereqs
382c94b
addressed dev review for prereqs and instructions
3af45e2
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger 1419fff
Update docs/modules/user-guide/partials/proc_developing-with-devfiles…
jc-berger e9678d2
removed unnecessary step in procedure
edd3545
changed prereqs and tightened procedure steps
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
:description: Developing with devfiles | ||
:navtitle: Developing with devfiles | ||
:keywords: developing, devfiles | ||
|
||
include::partial$proc_developing-with-devfiles.adoc[] |
36 changes: 36 additions & 0 deletions
36
docs/modules/user-guide/partials/proc_developing-with-devfiles.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
[id="proc_developing-with-devfiles_{context}"] | ||
= Developing with devfiles | ||
[role="_abstract"] | ||
|
||
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. | ||
|
||
.Prerequisites | ||
|
||
To make developing with the devfile specification easier, consider doing the following: | ||
|
||
* Install link:https://minikube.sigs.k8s.io/docs/start/[minikube] to create a Kubernetes cluster on your local machine. | ||
* Download link:https://kubernetes.io/docs/tasks/tools/install-kubectl-macos/[kubectl] to access your namespace. | ||
* Enable link:https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/[ingress on minikube] to access your devfile project. | ||
* 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. | ||
|
||
.Procedure | ||
|
||
. View the available devfiles: | ||
+ | ||
---- | ||
$ odo catalog list components | ||
---- | ||
. Run `odo create nodejs _<name of your project>_ --starter` to create a devfile project. | ||
* 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. | ||
. Run `minikube IP` to find your cluster IP address. | ||
. 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. | ||
* Example: `odo url create myfirstproject --ingress --host 192.168.64.2.nip.io`. | ||
. Run `odo push` to build the URL. | ||
jc-berger marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
.Verification | ||
|
||
* 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. | ||
|
||
.Additional resources | ||
|
||
To continue working with devfiles, go to xref:authoring-devfiles.adoc[Authoring devfiles]. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.