alihan/odo
1
0
Fork 0
mirror of https://github.com/redhat-developer/odo.git synced 2025-10-19 03:06:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clarify Odo terminology (#1420)

Browse Source 
Updates the README as well as documentation to indicate that it's "odo"
within a sentence and only capitalized "Odo" at the beginning of a
sentence.

Closes https://github.com/redhat-developer/odo/issues/1397
This commit is contained in:
Charlie Drage
2019-03-07 10:33:12 -05:00
committed by OpenShift Merge Robot
parent 92129cc582
commit 964874a383
8 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,6 +1,6 @@
<img src="./docs/img/openshift.png" width="180" align="right">
# Odo - OpenShift Do
# Odo - Developer Focused CLI for OpenShift
[![Build Status](https://travis-ci.org/redhat-developer/odo.svg?branch=master)](https://travis-ci.org/redhat-developer/odo) [![codecov](https://codecov.io/gh/redhat-developer/odo/branch/master/graph/badge.svg)](https://codecov.io/gh/redhat-developer/odo) [![CircleCI](https://circleci.com/gh/redhat-developer/odo/tree/master.svg?style=svg)](https://circleci.com/gh/redhat-developer/odo/tree/master) [![mattermost](/docs/img/mattermost.svg)](https://chat.openshift.io/developers/channels/odo)
@@ -21,7 +21,7 @@ A fast iterative tool for deploying your source code straight to OpenShift.
<details>
<summary> :package: :rocket: OS-independent automated install</summary>
#### The quickest way to install Odo is via this [bash script](./scripts/install.sh), which will automatically detect your operating system and install `odo` accordingly.
#### The quickest way to install odo is via this [bash script](./scripts/install.sh), which will automatically detect your operating system and install `odo` accordingly.
```sh
curl -L https://github.com/redhat-developer/odo/raw/master/scripts/install.sh | bash
@@ -62,7 +62,7 @@ sudo sh -c 'curl -L https://github.com/redhat-developer/odo/releases/download/v0
<details>
<summary> :package: :checkered_flag: Windows</summary>
#### In order to correctly use Odo you must add it to your PATH environment variable
#### In order to correctly use odo you must add it to your PATH environment variable
1. Download the `odo-windows-amd64.exe.gz` file from the [GitHub releases page](https://github.com/redhat-developer/odo/releases).
2. Extract the file
@@ -74,17 +74,17 @@ sudo sh -c 'curl -L https://github.com/redhat-developer/odo/releases/download/v0
## Purpose
OpenShift Do (Odo) is a CLI tool for developers who are writing, building, and deploying applications on OpenShift. With Odo, developers get an opinionated CLI tool that supports fast, iterative development which abstracts away Kubernetes and OpenShift concepts, thus allowing them to focus on what's most important to them: code.
OpenShift Do (odo) is a CLI tool for developers who are writing, building, and deploying applications on OpenShift. With odo, developers get an opinionated CLI tool that supports fast, iterative development which abstracts away Kubernetes and OpenShift concepts, thus allowing them to focus on what's most important to them: code.
Odo was created to improve the developer experience with OpenShift. Existing tools such as `oc` are more operations-focused and requires a deep-understanding of Kubernetes and OpenShift concepts. Odo is designed to be simple and concise so you may focus on coding rather than how to deploy your application. Since Odo can build and deploy your code to your cluster immediately after you save you changes, you benefit from instant feedback and can thus validate your changes in real-time. Odo's syntax and design is centered around concepts already familiar to developers, such as: project, application and component.
Odo was created to improve the developer experience with OpenShift. Existing tools such as `oc` are more operations-focused and requires a deep-understanding of Kubernetes and OpenShift concepts. Odo is designed to be simple and concise so you may focus on coding rather than how to deploy your application. Since odo can build and deploy your code to your cluster immediately after you save you changes, you benefit from instant feedback and can thus validate your changes in real-time. Odo's syntax and design is centered around concepts already familiar to developers, such as: project, application and component.
## Demo
[![asciicast](https://asciinema.org/a/225717.svg)](https://asciinema.org/a/225717)
## Deploying an Application using Odo
## Deploying an Application using odo
After you have Odo installed, follow these steps to build, push, and deploy a Node.js application using Odo. Examples for other supported languages and runtimes can be found [here](https://github.com/redhat-developer/odo/blob/master/docs/examples.md).
After you have odo installed, follow these steps to build, push, and deploy a Node.js application using odo. Examples for other supported languages and runtimes can be found [here](https://github.com/redhat-developer/odo/blob/master/docs/examples.md).
```sh
@@ -94,7 +94,7 @@ $ minishift start
# Log into the OpenShift cluster
$ odo login -u developer -p developer
# Create an application. An application in Odo is an umbrella under which you add other components
# Create an application. An application in odo is an umbrella under which you add other components
$ odo app create node-example-app
# Download the Node.js sample code
@@ -113,7 +113,7 @@ $ odo url create
$ curl nodejs-myproject.192.168.42.147.nip.io
```
For more in-depth information and advanced use-cases such as adding storage to a component or linking components, see the [interactive tutorial](https://learn.openshift.com/introduction/developing-with-odo/) or the [Odo user guide](/docs/getting-started.md).
For more in-depth information and advanced use-cases such as adding storage to a component or linking components, see the [interactive tutorial](https://learn.openshift.com/introduction/developing-with-odo/) or the [odo user guide](/docs/getting-started.md).
## Additional Documentation
@@ -127,9 +127,9 @@ Additional documentation can be found below:
## Community, Discussion, Contribution and Support
**Chat:** We have a public channel [#Odo on chat.openshift.io](https://chat.openshift.io/developers/channels/odo).
**Chat:** We have a public channel [#odo on chat.openshift.io](https://chat.openshift.io/developers/channels/odo).
**Issues:** If you have an issue with Odo, please [file it](https://github.com/redhat-developer/odo/issues).
**Issues:** If you have an issue with odo, please [file it](https://github.com/redhat-developer/odo/issues).
**Contributing:** Want to become a contributor and submit your own code? Have a look at our [development guide](https://github.com/redhat-developer/odo/blob/master/docs/development.md).