Skip to content

Commit

Permalink
Refactor Quickstart guide doc to use framework specific output
Browse files Browse the repository at this point in the history
Signed-off-by: Parthvi Vala <pvala@redhat.com>
  • Loading branch information
valaparthvi committed Jan 4, 2023
1 parent 4617cfd commit 642e2c5
Show file tree
Hide file tree
Showing 20 changed files with 345 additions and 121 deletions.
46 changes: 0 additions & 46 deletions docs/website/docs/user-guides/quickstart/_creating_app.mdx

This file was deleted.

41 changes: 0 additions & 41 deletions docs/website/docs/user-guides/quickstart/_running_command.mdx

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CreateNamespaceOutput from './create_namespace_output.mdx';
import CreateProjectOutput from './create_project_output.mdx';

Before starting you should make sure that odo is connected to your cluster and that you have created a new namespace (or project if you are using OpenShift).

Expand All @@ -10,11 +12,7 @@ Before starting you should make sure that odo is connected to your cluster and t

If you are using Kubernetes, you can create a new namespace with the `odo create namespace` command.

```console
$ odo create namespace odo-dev
✓ Namespace "odo-dev" is ready for use
✓ New namespace created and now using namespace: odo-dev
```
<CreateNamespaceOutput />

</TabItem>
<TabItem value="openshift" label="OpenShift">
Expand All @@ -33,11 +31,7 @@ The easiest way to connect `odo` to an OpenShift cluster is use copy "Copy login

If you are using OpenShift, you can create a new namespace with the `odo create project` command.

```console
$ odo create project odo-dev
✓ Project "odo-dev" is ready for use
✓ New project created and now using namespace: odo-dev
```
<CreateProjectOutput />

</TabItem>
</Tabs>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```console
$ odo create namespace odo-dev
✓ Namespace "odo-dev" is ready for use
✓ New namespace created and now using namespace: odo-dev
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```console
$ odo create project odo-dev
✓ Project "odo-dev" is ready for use
✓ New project created and now using namespace: odo-dev
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
```console
$ odo dev
__
/ \__ Developing using the "my-dotnet-app" Devfile
\__/ \ Namespace: default
/ \__/ odo version: v3.4.0
\__/

↪ Deploying to the cluster in developer mode
• Waiting for Kubernetes resources ...
⚠ Pod is Pending
✓ Pod is Running
✓ Syncing files into the container [171ms]
✓ Building your application in container on cluster (command: build) [7s]
• Executing the application (command: run) ...
- Forwarding from 127.0.0.1:40001 -> 8080


↪ Dev mode
Status:
Watching for changes in the current directory /home/user/quickstart-demo/dotnet-demo

Keyboard Commands:
[Ctrl+c] - Exit and delete resources from the cluster
[p] - Manually apply local changes to the application on the cluster

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
```console
$ odo init
__
/ \__ Initializing a new component
\__/ \ Files: Source code detected, a Devfile will be determined based upon source code autodetection
/ \__/ odo version: v3.4.0
\__/

Interactive mode enabled, please answer the following questions:
Based on the files in the current directory odo detected
Language: .NET
Project type: dotnet
The devfile "dotnet50:1.0.3" from the registry "DefaultDevfileRegistry" will be downloaded.
? Is this correct? No
? Select language: .NET
? Select project type: .NET 6.0
✓ Downloading devfile "dotnet60" from registry "DefaultDevfileRegistry" [3s]

↪ Container Configuration "dotnet":
OPEN PORTS:
- 8080
ENVIRONMENT VARIABLES:
- ASPNETCORE_URLS = http://*:8080
- CONFIGURATION = Debug
- STARTUP_PROJECT = app.csproj
- ASPNETCORE_ENVIRONMENT = Development

? Select container for which you want to change configuration? NONE - configuration is correct
? Enter component name: my-dotnet-app

You can automate this command by executing:
odo init --name my-dotnet-app --devfile dotnet60 --devfile-registry DefaultDevfileRegistry

Your new component 'my-dotnet-app' is ready in the current directory.
To start editing your component, use 'odo dev' and open this folder in your favorite IDE.
Changes will be directly reflected on the cluster.

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
```console
$ odo dev [5/22]
__
/ \__ Developing using the "my-go-app" Devfile
\__/ \ Namespace: default
/ \__/ odo version: v3.4.0
\__/

↪ Deploying to the cluster in developer mode
• Waiting for Kubernetes resources ...
⚠ Pod is Pending
✓ Pod is Running
✓ Syncing files into the container [113ms]
✓ Building your application in container on cluster (command: build) [422ms]
• Executing the application (command: run) ...
- Forwarding from 127.0.0.1:40001 -> 8080


↪ Dev mode
Status:
Watching for changes in the current directory /home/user/quickstart-demo/go-demo

Keyboard Commands:
[Ctrl+c] - Exit and delete resources from the cluster
[p] - Manually apply local changes to the application on the cluster

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
```console
$ odo init
__
/ \__ Initializing a new component
\__/ \ Files: Source code detected, a Devfile will be determined based upon source code autodetection
/ \__/ odo version: v3.4.0
\__/

Interactive mode enabled, please answer the following questions:
Based on the files in the current directory odo detected
Language: Go
Project type: Go
The devfile "go:1.0.2" from the registry "DefaultDevfileRegistry" will be downloaded.
? Is this correct? Yes
✓ Downloading devfile "go:1.0.2" from registry "DefaultDevfileRegistry" [3s]

↪ Container Configuration "runtime":
OPEN PORTS:
- 8080
ENVIRONMENT VARIABLES:

? Select container for which you want to change configuration? NONE - configuration is correct
? Enter component name: my-go-app

You can automate this command by executing:
odo init --name my-go-app --devfile go --devfile-registry DefaultDevfileRegistry --devfile-version 1.0.2

Your new component 'my-go-app' is ready in the current directory.
To start editing your component, use 'odo dev' and open this folder in your favorite IDE.
Changes will be directly reflected on the cluster.

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
```console
$ odo dev
__
/ \__ Developing using the "my-java-app" Devfile
\__/ \ Namespace: default
/ \__/ odo version: v3.4.0
\__/

↪ Deploying to the cluster in developer mode
• Waiting for Kubernetes resources ...
✓ Added storage m2 to component
⚠ Pod is Pending
⚠ 0/1 nodes are available: 1 pod has unbound immediate PersistentVolumeClaims. preemption: 0/1 nodes are available: 1 Preemption is not helpful for scheduling.
⚠ 0/1 nodes are available: 1 pod has unbound immediate PersistentVolumeClaims. preemption: 0/1 nodes are available: 1 Preemption is not helpful for scheduling.
⚠ 0/1 nodes are available: 1 pod has unbound immediate PersistentVolumeClaims. preemption: 0/1 nodes are available: 1 Preemption is not helpful for scheduling.
✓ Pod is Running
✓ Syncing files into the container [167ms]
✓ Building your application in container on cluster (command: mvn-package) [3m]
• Executing the application (command: run) ...
- Forwarding from 127.0.0.1:40001 -> 8080

- Forwarding from 127.0.0.1:40002 -> 5858


↪ Dev mode
Status:
Watching for changes in the current directory /home/user/quickstart-demo/java-demo

Keyboard Commands:
[Ctrl+c] - Exit and delete resources from the cluster
[p] - Manually apply local changes to the application on the cluster

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
```console
$ odo init
__
/ \__ Initializing a new component
\__/ \ Files: Source code detected, a Devfile will be determined based upon source code autodetection
/ \__/ odo version: v3.4.0
\__/

Interactive mode enabled, please answer the following questions:
Based on the files in the current directory odo detected
Language: Java
Project type: Maven
The devfile "java-maven:1.2.0" from the registry "DefaultDevfileRegistry" will be downloaded.
? Is this correct? Yes
✓ Downloading devfile "java-maven:1.2.0" from registry "DefaultDevfileRegistry" [3s]

↪ Container Configuration "tools":
OPEN PORTS:
- 8080
- 5858
ENVIRONMENT VARIABLES:
- DEBUG_PORT = 5858

? Select container for which you want to change configuration? NONE - configuration is correct
? Enter component name: my-java-app

You can automate this command by executing:
odo init --name my-java-app --devfile java-maven --devfile-registry DefaultDevfileRegistry --devfile-version 1.2.0

Your new component 'my-java-app' is ready in the current directory.
To start editing your component, use 'odo dev' and open this folder in your favorite IDE.
Changes will be directly reflected on the cluster.

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
```console
$ odo dev
__
/ \__ Developing using the "my-nodejs-app" Devfile
\__/ \ Namespace: default
/ \__/ odo version: v3.4.0
\__/

↪ Deploying to the cluster in developer mode
• Waiting for Kubernetes resources ...
⚠ Pod is Pending
✓ Pod is Running
✓ Syncing files into the container [193ms]
✓ Building your application in container on cluster (command: install) [5s]
• Executing the application (command: run) ...
- Forwarding from 127.0.0.1:40001 -> 3000

- Forwarding from 127.0.0.1:40002 -> 5858


↪ Dev mode
Status:
Watching for changes in the current directory /home/user/quickstart-demo/nodejs-demo

Keyboard Commands:
[Ctrl+c] - Exit and delete resources from the cluster
[p] - Manually apply local changes to the application on the cluster

```
Loading

0 comments on commit 642e2c5

Please sign in to comment.