Skip to content

Commit 6475768

Browse files
authored
update readme wordings (#1572)
1 parent 536e501 commit 6475768

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Overview
66

7-
OpenShift Connector extension provides an end-to-end developer experience for Red Hat OpenShift. Using this extension developers can easily create, deploy and live debug applications running on OpenShift.
7+
OpenShift Connector extension provides an end-to-end developer experience for Red Hat® OpenShift®. Using this extension, developers can easily create, deploy and live debug applications running on OpenShift.
88

99
* Demo: https://youtube.com/watch?v=m0wBKuKDYO0
1010

@@ -44,7 +44,7 @@ When working with [OpenShift Online](https://www.openshift.com/products/online/)
4444

4545
### Commands Available in OpenShift Application Explorer View
4646

47-
#### Commands for Cluster
47+
#### Commands for a Cluster
4848

4949
* `OpenShift: Log in to cluster` - Log in to your server and save login for subsequent use.
5050
* Credentials : Log in to the given server with the given credentials.
@@ -61,7 +61,7 @@ When working with [OpenShift Online](https://www.openshift.com/products/online/)
6161
#### Commands for a Project
6262

6363
* `Project -> New Component` - Create a new Component from the Project.
64-
* git - Use a git repository as the source for the Component.
64+
* git - Use a git repository as a source for the Component.
6565
* binary - Use binary file as a source for the Component
6666
* local - Use local directory as a source for the Component.
6767
* `Project -> New Service` - Perform Service Catalog operations when it is enabled.
@@ -70,7 +70,7 @@ When working with [OpenShift Online](https://www.openshift.com/products/online/)
7070
#### Commands for an Application
7171

7272
* `Application -> New Component` - Create a new Component inside the selected Application.
73-
* git - Use a git repository as the source for the Component.
73+
* git - Use a git repository as a source for the Component.
7474
* binary - Use binary file as a source for the Component
7575
* local - Use local directory as a source for the Component.
7676
* `Application -> New Service` - Perform Service Catalog operations when it is enabled.
@@ -82,39 +82,39 @@ When working with [OpenShift Online](https://www.openshift.com/products/online/)
8282
Components can be in 3 stages:
8383

8484
* pushed - When the components are deployed into the cluster.
85-
* not pushed - When are the components are in local config but NOT deployed into the cluster.
85+
* not pushed - When the components are in local config but NOT deployed into the cluster.
8686
* no context - When there is no context folder associated with the component in the workspace.
8787

8888
Components in different states have different set of commands available.
8989

90-
##### Command for a Pushed Component
90+
##### Commands for a `Pushed` Component
9191

9292
* `Component -> New URL` - Expose Component to the outside world. The URLs that are generated using this command, can be used to access the deployed Components from outside the Cluster. Push the component to reflect the changes on the cluster.
9393
* `Component -> New Storage` - Create Storage and mount to a Component. Push the component to reflect the changes on the cluster.
94-
* `Component -> Describe` - Describe the given Component in terminal window.
95-
* `Component -> Show Log` - Retrieve the log for the given Component.
96-
* `Component -> Follow Log` - Follow logs for the given Component.
94+
* `Component -> Describe` - Describe the given Component in terminal window or inside a webview editor.
95+
* `Component -> Show Log` - Retrieve the log for the given Component or inside a webview editor
96+
* `Component -> Follow Log` - Follow logs for the given Component or inside a webview editor
9797
* `Component -> Link Component` - Link Component to another Component.
9898
* `Component -> Link Service` - Link Component to a Service.
9999
* `Component -> Unlink` - Unlink Component from Component/Service.
100-
* `Component -> Open in Browser` - Open the exposed URL in browser.
100+
* `Component -> Open in Browser` - Open the exposed URL in default browser.
101101
* `Component -> Push` - Push the source code to a Component.
102102
* `Component -> Watch` - Watch for changes, update Component on change. This is not supported for git based components.
103103
* `Component -> Undeploy` - Undeploys a Component from the cluster. The component still resides in the local config.
104104
* `Component -> Delete` - Delete an existing Component from the cluster and removes the local config also.
105105
* `Component -> Debug` - Debug local Java or Node.js Component.
106106

107-
##### Commands for a not Pushed Component
107+
##### Commands for a `not pushed` Component
108108

109109
* `Component -> New URL` - Expose Component to the outside world. The URLs that are generated using this command, can be used to access the deployed Components from outside the Cluster.
110110
* `Component -> New Storage` - Create Storage and mount to a Component. Push the component to reflect the changes on the cluster.
111-
* `Component -> Describe` - Describe the given Component in terminal window.
111+
* `Component -> Describe` - Describe the given Component in terminal window or inside a webview editor.
112112
* `Component -> Push` - Push the source code to a Component.
113113
* `Component -> Delete` - Delete an existing Component from the local config.
114114

115-
##### Commands for a no context Component
115+
##### Commands for a `no context` Component
116116

117-
* `Component -> Describe` - Describe the given Component in terminal window.
117+
* `Component -> Describe` - Describe the given Component in terminal window or inside a webview editor.
118118
* `Component -> Import` - If the component was created using old version of the extension (`<=0.0.23`), users can use the `Import` action to migrate to latest version and import the metadata changes.
119119
* `Component -> Delete` - Delete an existing Component from the local config.
120120

@@ -135,7 +135,10 @@ Components in different states have different set of commands available.
135135

136136
**NOTE:** Currently we support creation of one component per folder. Multiple components from a folder might be supported in future releases.
137137

138-
#### Debug Support for Local Node.js and Java Components
138+
#### Debug Support
139+
140+
* Supports Local Node.js and Java Components
141+
* Does not support git and binary based components
139142

140143
'OpenShift: Debug' command simplifies the way to start debugging for OpenShift Components pushed to a cluster. It is an experimental feature, because it is using experimental OpenShift Do `debug` command under the hood and supports only local Java and Node.js components. The command is available from command palette and context menu for Component nodes in OpenShift Application Explorer view.
141144

@@ -177,8 +180,8 @@ To debug a Java Component, Java Language Support and Java Debugger Extensions ar
177180
### CLI Tools
178181

179182
This extension uses two CLI tools to interact with OpenShift cluster:
180-
* OKD CLI client tool - [oc](https://github.com/openshift/origin/releases)
181-
* OpenShift Do tool - [odo](https://mirror.openshift.com/pub/openshift-v4/clients/odo)
183+
* OKD CLI client tool - [oc](https://mirror.openshift.com/pub/openshift-v4/clients/ocp/4.3.3)
184+
* OpenShift Do tool - [odo](http://mirror.openshift.com/pub/openshift-v4/clients/odo/v1.2.1/)
182185

183186
> `oc` and `odo` tools for Windows, Linux and macOS are included into extension package. Once the extension is installed it is ready to use.
184187
@@ -195,7 +198,7 @@ OpenShift Connector extension also provides ```Use Project``` command to switch
195198

196199
## Breaking Changes Between Previous Releases
197200

198-
### Updating from release 0.0.23 or earlier
201+
### Updating from release `0.0.23` or earlier
199202

200203
* The Components created with previous versions(<=0.0.23) will no longer be visible in OpenShift Application Explorer view.
201204
* The Extension will prompt the user to specify the context folder when creating new Components and then add selected folder to workspace.
@@ -215,7 +218,7 @@ This is an open source project open to anyone. This project welcomes contributio
215218

216219
For information on getting started, refer to the [CONTRIBUTING instructions](CONTRIBUTING.md).
217220

218-
Download the most recent `openshift-connector-<version>.vsix` file and install it by following the instructions [here](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix). Stable releases are archived [here](https://download.jboss.org/jbosstools/adapters/snapshots/vscode-openshift-tools/?C=M;O=D).
221+
Download the most recent `openshift-connector-<version>.vsix` file from the [release](https://github.com/redhat-developer/vscode-openshift-tools/releases) and install it by following the instructions [here](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix). Stable releases are archived [here](https://download.jboss.org/jbosstools/adapters/snapshots/vscode-openshift-tools/?C=M;O=D).
219222

220223
# Feedback & Questions
221224

0 commit comments

Comments
 (0)