Removes Why Did We Create Odo and cleans up README #930
Conversation
|
Code Climate has analyzed commit dcb89f8 and detected 0 issues on this pull request. View more on Code Climate. |
|
✅ odo build 64 completed and artifacts can be found here (for commit 6278d1f212 by @cdrage) |
README.md
Outdated
|
|
||
| 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 depp-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. |
There was a problem hiding this comment.
Typo: depp->deep. Also I don't think that deep understanding is hyphenated.
There was a problem hiding this comment.
I would still mention odo core concepts here (project, application, components).
README.md
Outdated
|
|
||
| Odo is *not* a replacement for the standard `oc` CLI tool, and it is not intended to be used by operations, security, or release management teams. | ||
| - Designed for fast, iterative developmeny cycles |
There was a problem hiding this comment.
developmeny -> development
README.md
Outdated
|
|
||
| Odo is *not* a replacement for the standard `oc` CLI tool, and it is not intended to be used by operations, security, or release management teams. | ||
| - Designed for fast, iterative developmeny cycles | ||
| - No server needed. 100% OpenShift API communication |
README.md
Outdated
| - Supports multiple languages and frameworks such as Node.js, Java, Ruby, Perl, PHP and Python | ||
| - Detect changes to your local code and deploy automatically with `odo watch` | ||
| - List all available components and services from your OpenShift cluster | ||
| - Support for linking and multiple deployments |
There was a problem hiding this comment.
Not clear. Also not a fan of feature list because they tend to get outdated.
Removes the "Why Did we Create Odo" section and cleans up the README so it's more concise / smaller. I believe that there's *too much* text and multiple paragraphs that iterate over the same concept (Odo is fast, it reduces development time, etc.). Having a few sentences / list of features is more than enough.
cdrage
force-pushed
the
update-readme-a-bit
branch
from
ebfdf8e
to
dcb89f8
Compare
Codecov Report
@@ Coverage Diff @@
## master #930 +/- ##
=======================================
Coverage 46.53% 46.53%
=======================================
Files 18 18
Lines 2933 2933
=======================================
Hits 1365 1365
Misses 1423 1423
Partials 145 145Continue to review full report at Codecov.
|
|
@metacosm Updated the README to address your comments 👍 |
|
@cdrage did you force push? The UI fails to show updates. Looking at the files directly, LGTM, though. |
) Removes the "Why Did we Create Odo" section and cleans up the README so it's more concise / smaller. I believe that there's *too much* text and multiple paragraphs that iterate over the same concept (Odo is fast, it reduces development time, etc.). Having a few sentences / list of features is more than enough.
Removes the "Why Did we Create Odo" section and cleans up the README so
it's more concise / smaller.
I believe that there's too much text and multiple paragraphs that iterate
over the same concept (Odo is fast, it reduces development time, etc.).
Having a few sentences / list of features is more than enough.