Skip to content

Commit

Permalink
Reorganizes installation document
Browse files Browse the repository at this point in the history
<!--
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:**

- Separates Homebrew and Binary sections for MAC
- Separates installing from source / maven plugins / etc.

**Which issue(s) this PR fixes:**
<!--
Specifying the issue will automatically close it when this PR is merged
-->

Fixes #6082

**PR acceptance criteria:**

- [ ] Unit test

- [ ] Integration test

- [ ] Documentation

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

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
  • Loading branch information
cdrage committed Sep 6, 2022
1 parent fe0832b commit 3721392
Showing 1 changed file with 41 additions and 39 deletions.
80 changes: 41 additions & 39 deletions docs/website/docs/overview/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@ sidebar_position: 4

`odo` can be used as either a [CLI tool](./installation#cli-binary-installation) or an [IDE plugin](./installation#ide-installation) on Mac, Windows or Linux.

## CLI installation

Each release is *signed*, *checksummed*, *verified*, and then pushed to our [binary mirror](https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/).

For more information on the changes of each release, they can be viewed either on [GitHub](https://github.com/redhat-developer/odo/releases) or the [blog](/blog).

### Linux
## Linux

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down Expand Up @@ -153,14 +151,33 @@ echo 'export PATH=$PATH:$HOME/bin' >> ~/.bashrc

---

### MacOS
## MacOS

### Homebrew

**NOTE:** This will install from the *main* branch on GitHub

Installing `odo` using [Homebrew](https://brew.sh/):

1. Install odo:

```shell
brew install --HEAD odo-dev
```

2. Verify the version you installed is up-to-date:

```shell
odo version
```

### Binary

<Tabs
defaultValue="intel"
values={[
{label: 'Intel', value: 'intel'},
{label: 'Apple Silicon', value: 'arm'},
{label: 'Homebrew', value: 'homebrew'},
]}>

<TabItem value="intel">
Expand Down Expand Up @@ -227,31 +244,11 @@ echo 'export PATH=$PATH:$HOME/bin' >> ~/.bashrc
```
</TabItem>

<TabItem value="homebrew">

**NOTE:** This will install from the *main* branch on GitHub

Installing `odo` using [Homebrew](https://brew.sh/):

1. Install odo:

```shell
brew install --HEAD odo-dev
```

2. Verify the version you installed is up-to-date:

```shell
odo version
```

</TabItem>

</Tabs>

---

### Windows
## Windows

1. Open a PowerShell terminal

Expand All @@ -270,8 +267,24 @@ type odo.exe.sha256

4. Add the binary to your `PATH`

## Visual Studio Code Plugin

Installs `odo` capabilities Visual Studio Code (VSCode).

The [OpenShift VSCode extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-openshift-connector) uses both `odo` and `oc` binary to interact with Kubernetes or OpenShift cluster.

1. Open VS Code.
2. Launch VS Code Quick Open (Ctrl+P)
3. Paste the following command:
```shell
ext install redhat.vscode-openshift-connector
```

## Alternative installation methods

### Installing from source code


### Source code
1. Clone the repository and cd into it.
```shell
git clone https://github.com/redhat-developer/odo.git
Expand All @@ -298,22 +311,11 @@ type odo.exe.sha256
odo version
```
### Installing `odo` using Maven plugin
### Maven plugin
It is possible to integrate the odo binary download in a Maven project using [odo Downloader Plugin](https://github.com/tnb-software/odo-downloader).
The download can be executed using `download` goal which automatically retrieves the version for the current architecture:
```shell
mvn software.tnb:odo-downloader-maven-plugin:0.1.3:download \
-Dodo.target.file=$HOME/bin/odo \
-Dodo.version=v3.0.0~rc1
```

## IDE Installation

### Installing `odo` in Visual Studio Code (VSCode)
The [OpenShift VSCode extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-openshift-connector) uses both `odo` and `oc` binary to interact with Kubernetes or OpenShift cluster.
1. Open VS Code.
2. Launch VS Code Quick Open (Ctrl+P)
3. Paste the following command:
```shell
ext install redhat.vscode-openshift-connector
```

0 comments on commit 3721392

Please sign in to comment.