mirror of
https://github.com/redhat-developer/odo.git
synced 2025-10-19 03:06:19 +03:00
Update README.md with logo & updated text (#6104)
* Update README.md with logo & updated text <!-- Thank you for opening a PR! Here are some things you need to know before submitting: 1. Please read our developer guideline: https://github.com/redhat-developer/odo/wiki/Dev:-odo-Dev-Guidelines 2. Label this PR accordingly with the '/kind' line 3. Ensure you have written and ran the appropriate tests: https://github.com/redhat-developer/odo/wiki/Dev:-Writing-and-running-tests 4. Read how we approve and LGTM each PR: https://github.com/redhat-developer/odo/wiki/Pull-Requests:-Review-guideline Documentation: If you are pushing a change to documentation, please read: https://github.com/redhat-developer/odo/wiki/Documentation:-Contributing --> **What type of PR is this:** <!-- Add one of the following kinds: /kind bug /kind feature /kind cleanup /kind tests Feel free to use other [labels](https://github.com/redhat-developer/odo/labels) as needed. However one of the above labels must be present or the PR will not be reviewed. This instruction is for reviewers as well. --> /kind documentation **What does this PR do / why we need it:** * Reorganizes the README (telemetry on the bottom + legal disclaimer) * Adds new text from the website * Adds logo **Which issue(s) this PR fixes:** <!-- Specifying the issue will automatically close it when this PR is merged --> Fixes https://github.com/redhat-developer/odo/issues/5393 Signed-off-by: Charlie Drage <charlie@charliedrage.com> * update based on reviews Signed-off-by: Charlie Drage <charlie@charliedrage.com> * Update README.md Co-authored-by: Parthvi Vala <pvala@redhat.com> Signed-off-by: Charlie Drage <charlie@charliedrage.com> Co-authored-by: Parthvi Vala <pvala@redhat.com>
This commit is contained in:
63
README.md
63
README.md
@@ -1,4 +1,4 @@
|
||||
`odo` - Developer-focused CLI for Kubernetes and OpenShift
|
||||
`odo` - Developer-focused CLI for fast & interative application development on Kubernetes
|
||||
---
|
||||
|
||||
[](https://github.com/redhat-developer/odo/releases/latest)
|
||||
@@ -6,48 +6,40 @@
|
||||
[](https://odo.dev/godoc)
|
||||
[](https://app.netlify.com/sites/odo-docusaurus-preview/deploys)
|
||||
|
||||

|
||||
|
||||
----
|
||||
|
||||
### Overview
|
||||
|
||||
`odo` is a fast, iterative, and straightforward CLI tool for developers who write, build, and deploy applications on Kubernetes and OpenShift.
|
||||
`odo` is a fast, and iterative CLI tool for developers who write, build, and deploy applications on Kubernetes and OpenShift.
|
||||
|
||||
Existing tools such as `kubectl` and `oc` are more operations-focused and require a deep-understanding of Kubernetes and OpenShift concepts. `odo` abstracts away complex Kubernetes and OpenShift concepts for the developer.
|
||||
Why use `odo`?
|
||||
|
||||
### Key features
|
||||
|
||||
`odo` is designed to be simple and concise with the following key features:
|
||||
|
||||
* Simple syntax and design centered around concepts familiar to developers, such as projects, applications, and components.
|
||||
* Completely client based. No additional server other than Kubernetes or OpenShift is required for deployment.
|
||||
* Official support for Node.js and Java components.
|
||||
* Detects changes to local code and deploys it to the cluster automatically, giving instant feedback to validate changes in real time.
|
||||
* Lists all the available components and services from the cluster.
|
||||
* **Fast:** Spend less time maintaining your application deployment infrastructure and more time coding. Immediately have your application running each time you save.
|
||||
* **Standalone:** `odo` is a standalone tool that communicates directly with the Kubernetes API. There is no requirement for a daemon or server process.
|
||||
* **No configuration needed:** There is no need to dive into complex Kubernetes yaml configuration files. `odo` abstracts those concepts away and lets you focus on what matters most: code.
|
||||
* **Containers first:** We provide first class support for both Kubernetes and OpenShift. Choose your favourite container orchestrator and develop your application.
|
||||
* **Easy to learn:** Simple syntax and design centered around concepts familiar to developers, such as projects, applications, and components.
|
||||
|
||||
Learn more about the features provided by odo on [odo.dev](https://odo.dev/docs/overview/features).
|
||||
|
||||
### Core concepts
|
||||
|
||||
Learn more about core concepts of odo on [odo.dev](https://odo.dev/docs/overview/basics).
|
||||
|
||||
|
||||
### Usage data
|
||||
|
||||
When odo is run the first time, you will be asked to opt-in to Red Hat's telemetry collection program.
|
||||
|
||||
With your approval, odo will collect pseudonymized usage data and send it to Red Hat servers to help improve our products and services. Read our [privacy statement](https://developers.redhat.com/article/tool-data-collection) to learn more about it. For the specific data being collected and to configure this data collection process, see [Usage data](USAGE_DATA.md).
|
||||
|
||||
### Official documentation
|
||||
|
||||
Visit [odo.dev](https://odo.dev/) to learn more about odo.
|
||||
----
|
||||
|
||||
### Installing `odo`
|
||||
|
||||
Please check the [installation guide on odo.dev](https://odo.dev/docs/overview/installation/).
|
||||
|
||||
----
|
||||
|
||||
### Official documentation
|
||||
|
||||
Visit [odo.dev](https://odo.dev/) to learn more about odo.
|
||||
|
||||
----
|
||||
|
||||
### Community, discussion, contribution, and support
|
||||
|
||||
|
||||
#### Chat
|
||||
|
||||
All of our developer and user discussions happen in the [#odo channel on the official Kubernetes Slack](https://kubernetes.slack.com/archives/C01D6L2NUAG).
|
||||
@@ -60,14 +52,29 @@ Ask questions, inquire about odo or even discuss a new feature.
|
||||
|
||||
If you find an issue with `odo`, please [file it here](https://github.com/redhat-developer/odo/issues).
|
||||
|
||||
|
||||
#### Contributing
|
||||
|
||||
* Code: We are currently working on updating our code contribution guide.
|
||||
* Documentation: To contribute to the documentation, please have a look at our [Documentation Guide](https://github.com/redhat-developer/odo/wiki).
|
||||
|
||||
We are an open community who welcomes any concerns, changes or ideas for `odo`! Come join the chat and hang out, ask or give feedback and just generally have a good time.
|
||||
|
||||
#### Meetings
|
||||
|
||||
All our calls are open to public. You are welcome to join any of our calls.
|
||||
|
||||
You can find the exact dates of all scheduled odo calls together with sprint dates in the [odo calendar](https://calendar.google.com/calendar/embed?src=gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com) ([iCal format](https://calendar.google.com/calendar/ical/gi0s0v5ukfqkjpnn26p6va3jfc%40group.calendar.google.com/public/basic.ics)).
|
||||
|
||||
----
|
||||
|
||||
### Legal
|
||||
|
||||
#### License
|
||||
|
||||
Unless otherwise stated (ex. `/vendor` files), all code is licensed under the [Apache 2.0 License](LICENSE).
|
||||
|
||||
#### Usage data
|
||||
|
||||
When `odo` is ran for the first time, you will be asked to opt-in to Red Hat's telemetry collection program.
|
||||
|
||||
With your approval, `odo` will collect pseudonymized usage data and send it to Red Hat servers to help improve our products and services. Read our [privacy statement](https://developers.redhat.com/article/tool-data-collection) to learn more about it. For the specific data being collected and to configure this data collection process, see [Usage data](USAGE_DATA.md).
|
||||
|
||||
BIN
docs/website/static/img/logo_small.png
Normal file
BIN
docs/website/static/img/logo_small.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Reference in New Issue
Block a user