Skip to content

Commit 06b95fc

Browse files
authored
Change wording for dev/deploy (#6408)
* Change wording for dev/deploy * Update doc * Fix help tests * Update deploy help message
1 parent f39c5b6 commit 06b95fc

File tree

9 files changed

+20
-20
lines changed

9 files changed

+20
-20
lines changed

cmd/odo/help_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Examples:
2929

3030
mainCommands = `Main Commands:
3131
build-images Build images
32-
deploy Deploy components
33-
dev Deploy component to development cluster
32+
deploy Run your application on the cluster in the Deploy mode
33+
dev Run your application on the cluster in the Dev mode
3434
init Init bootstraps a new project
3535
logs Show logs of all containers of the component
3636
registry List all components from the Devfile registry

docs/website/docs/command-reference/dev.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ $ odo dev
2626
/ \__/ odo version: v3.0.0-alpha1
2727
\__/
2828

29-
Deploying to the cluster in developer mode
29+
Running on the cluster in Dev mode
3030
✓ Waiting for Kubernetes resources [3s]
3131
✓ Syncing files into the container [335ms]
3232
✓ Building your application in container on cluster [2s]
@@ -113,7 +113,7 @@ $ odo dev --build-command my-build-with-version
113113
/ \__/ odo version: v3.0.0-alpha3
114114
\__/
115115
116-
Deploying to the cluster in developer mode
116+
Running on the cluster in Dev mode
117117
✓ Waiting for Kubernetes resources [39s]
118118
✓ Syncing files into the container [84ms]
119119
✓ Building your application in container on cluster (command: my-build-with-version) [456ms]
@@ -175,7 +175,7 @@ $ odo dev --run-command my-run-with-postgres
175175
/ \__/ odo version: v3.0.0-alpha3
176176
\__/
177177
178-
Deploying to the cluster in developer mode
178+
Running on the cluster in Dev mode
179179
✓ Added storage m2 to my-java-springboot-app
180180
✓ Creating kind ServiceBinding [8ms]
181181
✓ Waiting for Kubernetes resources [39s]

docs/website/docs/user-guides/advanced/connecting-a-service.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ $ odo dev
107107
/ \__/ odo version: v3.0.0-rc1
108108
\__/
109109

110-
Deploying to the cluster in developer mode
110+
Running on the cluster in Dev mode
111111
• Waiting for Kubernetes resources ...
112112
⚠ Pod is Pending
113113
✓ Pod is Running
@@ -191,7 +191,7 @@ $ odo dev
191191
/ \__/ odo version: v3.0.0-rc1
192192
\__/
193193

194-
Deploying to the cluster in developer mode
194+
Running on the cluster in Dev mode
195195
• Waiting for Kubernetes resources ...
196196
⚠ Pod is Pending
197197
✓ Pod is Running

docs/website/docs/user-guides/quickstart/docs-mdx/dotnet/dotnet_odo_dev_output.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ $ odo dev
66
/ \__/ odo version: v3.5.0
77
\__/
88

9-
Deploying to the cluster in developer mode
9+
Running on the cluster in Dev mode
1010
• Waiting for Kubernetes resources ...
1111
⚠ Pod is Pending
1212
✓ Pod is Running

docs/website/docs/user-guides/quickstart/docs-mdx/go/go_odo_dev_output.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ $ odo dev
66
/ \__/ odo version: v3.5.0
77
\__/
88

9-
Deploying to the cluster in developer mode
9+
Running on the cluster in Dev mode
1010
• Waiting for Kubernetes resources ...
1111
⚠ Pod is Pending
1212
✓ Pod is Running

docs/website/docs/user-guides/quickstart/docs-mdx/java/java_odo_dev_output.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ $ odo dev
66
/ \__/ odo version: v3.5.0
77
\__/
88

9-
Deploying to the cluster in developer mode
9+
Running on the cluster in Dev mode
1010
• Waiting for Kubernetes resources ...
1111
✓ Added storage m2 to component
1212
⚠ Pod is Pending

docs/website/docs/user-guides/quickstart/docs-mdx/nodejs/nodejs_odo_dev_output.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ $ odo dev
66
/ \__/ odo version: v3.5.0
77
\__/
88

9-
Deploying to the cluster in developer mode
9+
Running on the cluster in Dev mode
1010
• Waiting for Kubernetes resources ...
1111
⚠ Pod is Pending
1212
✓ Pod is Running

pkg/odo/cli/deploy/deploy.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ type DeployOptions struct {
3333
var _ genericclioptions.Runnable = (*DeployOptions)(nil)
3434

3535
var deployExample = templates.Examples(`
36-
# Deploy components defined in the devfile
36+
# Run the components defined in the Devfile on the cluster in the Deploy mode
3737
%[1]s
3838
`)
3939

@@ -77,7 +77,7 @@ func (o *DeployOptions) Run(ctx context.Context) error {
7777
scontext.SetProjectType(ctx, devfileObj.Data.GetMetadata().ProjectType)
7878
scontext.SetDevfileName(ctx, devfileName)
7979
// Output what the command is doing / information
80-
log.Title("Deploying the application using "+devfileName+" Devfile",
80+
log.Title("Running the application in Deploy mode using "+devfileName+" Devfile",
8181
"Namespace: "+namespace,
8282
"odo version: "+version.VERSION)
8383

@@ -96,8 +96,8 @@ func NewCmdDeploy(name, fullName string) *cobra.Command {
9696
o := NewDeployOptions()
9797
deployCmd := &cobra.Command{
9898
Use: name,
99-
Short: "Deploy components",
100-
Long: "Deploy the components defined in the devfile",
99+
Short: "Run your application on the cluster in the Deploy mode",
100+
Long: "Run the components defined in the Devfile on the cluster in the Deploy mode",
101101
Example: fmt.Sprintf(deployExample, fullName),
102102
Args: cobra.MaximumNArgs(0),
103103
RunE: func(cmd *cobra.Command, args []string) error {

pkg/odo/cli/dev/dev.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@ func NewDevOptions() *DevOptions {
6767
}
6868

6969
var devExample = ktemplates.Examples(`
70-
# Deploy component to the development cluster, using the default run command
70+
# Run your application on the cluster in the Dev mode, using the default run command
7171
%[1]s
7272
73-
# Deploy component to the development cluster, using the specified run command
73+
# Run your application on the cluster in the Dev mode, using the specified run command
7474
%[1]s --run-command <my-command>
7575
76-
# Deploy component to the development cluster without automatically syncing the code upon any file changes
76+
# Run your application on the cluster in the Dev mode, without automatically syncing the code upon any file changes
7777
%[1]s --no-watch
7878
`)
7979

@@ -170,7 +170,7 @@ func (o *DevOptions) Run(ctx context.Context) (err error) {
170170
scontext.SetProjectType(ctx, devFileObj.Data.GetMetadata().ProjectType)
171171
scontext.SetDevfileName(ctx, componentName)
172172

173-
log.Sectionf("Deploying to %s in developer mode", deployingTo)
173+
log.Sectionf("Running on %s in Dev mode", deployingTo)
174174

175175
return o.clientset.DevClient.Start(
176176
o.ctx,
@@ -207,7 +207,7 @@ func NewCmdDev(name, fullName string) *cobra.Command {
207207
o := NewDevOptions()
208208
devCmd := &cobra.Command{
209209
Use: name,
210-
Short: "Deploy component to development cluster",
210+
Short: "Run your application on the cluster in the Dev mode",
211211
Long: `odo dev is a long running command that will automatically sync your source to the cluster.
212212
It forwards endpoints with any exposure values ('public', 'internal' or 'none') to a port on localhost.`,
213213
Example: fmt.Sprintf(devExample, fullName),

0 commit comments

Comments
 (0)