88 Commits

Author SHA1 Message Date
Armel Soro
b471f4b6de Update README main title and display preview video (#7037)
* Update main title in README

* Remove extra colon character

* Remove horizontal rules in README

Headings should suffice.

* Display demo video in README

This way, users can have a chance to have a quick preview of odo.
2023-08-22 10:11:20 -02:30
Armel Soro
6e3a85f9d2 Update home page preview video with support of Podman (#7023)
* Update home page preview video with support of Podman

* Update README and project description with mention of Podman support
2023-08-04 14:41:24 +02:00
Parthvi Vala
a88eace7a1 Minor fixes to documentation (#6230)
* Minor fixes to documentation

* Modify the README to highlight odo
2022-10-20 05:31:33 -04:00
Armel Soro
5d4f1b2f08 Fix typo in README (#6133) 2022-09-19 10:29:28 +02:00
Charlie Drage
0664d6739e 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>
2022-09-16 14:10:56 +02:00
Charlie Drage
e1a16a64c7 Make 3.0.0 the default on the site (#5857)
* Make 3.0.0 the default on the site

<!--
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:**

* Moves the 3.0.0 documentation to current
* Changes the "intro" page to "introduction" due to limitations of
  docusaurus index paging.

**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/5842

**PR acceptance criteria:**

- [X] Documentation

**How to test changes / Special notes to the reviewer:**

Signed-off-by: Charlie Drage <charlie@charliedrage.com>

* fix broken links

* fix more links
2022-06-27 14:32:09 -04:00
Tomas Kral
d0d06ab1be Update README.md (#5835)
fix link to contributing guide
2022-06-17 04:24:52 +00:00
Tomas Kral
5f79c542a8 openshift/odo -> redhat-developer/odo (#5268)
* openshift/odo -> redhat-developer/odo

* update more links to redhat-developer
2021-12-01 16:38:34 +01:00
Dharmit Shah
d07991e429 Update README and change from AsciiDoc to Markdown (#5183)
* Update README and change from AsciiDoc to Markdown

* Update funny sentence

Co-authored-by: Parthvi Vala <pvala@redhat.com>

* Update usage data from adoc to md

* Update link

* Remove Changelog file since we no longer use it

* Add godoc to README

* Update USAGE_DATA.md

Co-authored-by: Parthvi Vala <pvala@redhat.com>

Co-authored-by: Parthvi Vala <pvala@redhat.com>
2021-10-28 17:20:24 +00:00
Preeti Chandrashekar
c13dca8d6d Readme conversion from .md to .adoc (#1566)
* Fresh PR for readme adoc conversion.

* Deleting the markdown file

* Changes to the command format for better rendering

* Changing `odo` to OpenShift Do in headings and titles

* Changed back to `odo` based on steve's input
2019-04-08 13:28:55 -07:00
Corey Daley
b0ff45efa3 Removing extra backticks (#1556) 2019-04-03 22:35:46 -07:00
Dharmit Shah
36e804bdb1 Update OpenShift version based on what minishift supports (#1538)
minishift supports OpenShift version 3.10 and above.
2019-04-02 07:23:05 -07:00
Tomas Kral
6bd0d73dc6 redhat-developer/odo -> openshift/odo (#1505)
* redhat-developer/odo -> openshift/odo

* gofmt

* add CircleCI tests temporary back to TravisCI
2019-03-21 17:36:28 +01:00
Preeti Chandrashekar
0625e25be9 Readme edits (#1462)
* readme edits

* edits based on review comments

* changes as per review comments
2019-03-21 07:59:59 +01:00
Charlie Drage
964874a383 Clarify Odo terminology (#1420)
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
2019-03-07 07:33:12 -08:00
Charlie Drage
e4a4530bbf Updates the README.md with a new layout (#1299)
Updates the README.md with a more intuitive layout.

It also:

- Moves around a few things
- Uses the <section> feature of GitHub to make installation pages
dropdown
- Floats the logo to the right
- Changes the gif to asciinema
2019-02-28 12:16:51 -05:00
Suraj Narwade
bd3e74a4eb release v0.0.20 (#1387) 2019-02-27 19:45:24 +05:30
girish ramnani
e66549fbe3 added circle ci badge (#1351) 2019-02-21 12:15:55 +05:30
Suraj Narwade
61f278a13f Release v0.0.19 (#1315) 2019-02-11 17:14:52 +05:30
Charlie Drage
31e898e60c Release 0.0.18 (#1246) 2019-01-28 20:32:18 -05:00
arout
0cea48211a Missing Deploying an Application using Odo link 2018-12-07 16:55:48 +05:30
Charlie Drage
29435726ae 0.0.17 Release (#1067) 2018-12-03 15:19:07 -05:00
Georgios Andrianakis
16abaca3e9 Remove outdated reference to oc being necessary (#1050)
Fixes: #1044
2018-11-29 08:49:21 +02:00
Charlie Drage
82968cb05b 0.0.16 Release (#1018) 2018-11-20 15:28:01 -05:00
Charlie Drage
2f7ed49711 Release 0.0.15 (#972) 2018-11-13 12:55:09 -05:00
Charlie Drage
7f1251b0f8 Removes Why Did We Create Odo and cleans up README (#930)
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.
2018-11-07 09:50:09 -05:00
Charlie Drage
56ecc2473f Add asciinema / demo gif (#909)
Adds a demo gif to the README.md that shows us deploying a sample nodejs
application.

Closes https://github.com/redhat-developer/odo/issues/332
2018-11-05 08:35:59 -05:00
Charlie Drage
2c807587d8 Update the README.md (#910)
A few things within README.md and the getting-started.md guide were
outdated. I've gone over and quickly updated a few changes.
2018-11-01 08:52:21 -04:00
Charlie Drage
191b3c54c5 Update README index (#884)
For some reason, `####` was added for the index page.

It's been removed so there are no newlines for Odo.
2018-10-29 12:17:13 -04:00
Charlie Drage
83fa51b230 Remove "cli structure" information from README.md
This information is already available within: https://github.com/redhat-developer/odo/blob/master/docs/cli-reference.md

We remove this from the README.md in favour of the above.
2018-10-25 08:49:17 -04:00
Charlie Drage
618c6d34c6 Release 0.0.14 (#850) 2018-10-19 13:36:36 -04:00
Georgios Andrianakis
afb3649f11 Apply minor doc fixes (#824) 2018-10-12 15:41:17 -04:00
Jan Kleinert
1f27118426 Updated the README and other docs (#819) 2018-10-11 11:23:22 +05:30
Charlie Drage
f92c3528e1 0.0.13 release (#794)
0.0.13 release
2018-09-28 15:57:13 -04:00
Tomas Kral
bb3e66d182 v0.0.12 2018-09-19 16:23:54 +02:00
anmolbabu
0764b574d4 Bump version to 0.0.11 (#733)
Signed-off-by: anmolbabu <anmolbudugutta@gmail.com>
2018-09-14 17:41:13 +05:30
Gunnar Morling
eff975bdcc #686 Adding Java as supported language to README.md (#698) 2018-09-06 14:37:57 -04:00
Syam.G.Krishnan
2bb2dca872 add config command for toggling update checker (#589)
* add odo utils config command for enable/disable parameters

- add config command
- create a new field 'config' in odoconfig file
  for storing odo specific configurations

* update CLI structure in Readme.md
2018-09-04 12:43:54 -04:00
Suraj Narwade
eea727b6d6 Updated cli structure in README.md 2018-08-30 14:10:37 +05:30
Suraj Narwade
2f60a7206b v0.0.10 (#662) 2018-08-24 19:10:08 +05:30
Suraj Narwade
1a7dfd97a1 v0.10.0 (#661) 2018-08-24 19:03:05 +05:30
Tomas Kral
8b7a724166 v0.0.9 2018-08-08 11:45:14 +02:00
donal
6073ae1eab FIX - sudo permission issue on mac install 2018-08-03 11:35:09 +01:00
Tomas Kral
292556e417 v0.0.8 2018-07-20 10:43:35 +02:00
Tomas Kral
1d6e463d2f Merge pull request #539 from cdrage/add-public-channel-to-readme
Add public channel, community and contribution info
2018-06-27 15:45:41 +02:00
Charlie Drage
cd8bdde2d0 Add public channel, community and contribution info
This adds the public channel, issue and contribution information to the
README.md
2018-06-26 09:03:41 -04:00
mdas
34278bd236 Updating th oc cluster version
Signed-off-by: mdas <mrinald7@gmail.com>
2018-06-26 15:18:09 +05:30
Tomas Kral
ee258eb859 v0.0.7 2018-06-25 17:15:54 +02:00
Charlie Drage
a6c863d4ab Update installation instructions, add binaries
Updates the current installation instuctions. Adds links to the
binaries.
2018-06-22 09:06:57 -04:00
Praveen Kumar
a8ee29a885 Update README.md
Update the link to minishift and openshift site to get oc binary.
2018-05-31 14:02:31 +00:00