-
Notifications
You must be signed in to change notification settings - Fork 244
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add odo installation docs #4923
Add odo installation docs #4923
Conversation
f3de5a4
to
6fe84c7
Compare
``` | ||
5. Run the command to verify that it was installed properly. | ||
```shell | ||
odo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Running odo version
would help the user check that he doesn't have a previously installed one he completely forgot in another PATH's directory.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To run the odo binary built from the source, the user would have to do ./odo
and not odo
.
./odo
refers to the one built using steps mentioned here.odo
refers to a previously installed binary that is already present inPATH
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
./odo
would this also be true for windows?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To run the odo binary built from the source, the user would have to do
./odo
and notodo
.
./odo
refers to the one built using steps mentioned here.odo
refers to a previously installed binary that is already present inPATH
.
But the step make install
has installed odo
in $GOPATH/bin
, which is, probably, in the PATH
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But the step
make install
has installedodo
in$GOPATH/bin
, which is, probably, in thePATH
Ah. Totally missed that. I use make && cp -f odo ~/bin/odo
on my local system so I was under that mindset.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am a little confused about this discussion. Does the current content look okay?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes.
``` | ||
5. Run the command to verify that it was installed properly. | ||
```shell | ||
odo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To run the odo binary built from the source, the user would have to do ./odo
and not odo
.
./odo
refers to the one built using steps mentioned here.odo
refers to a previously installed binary that is already present inPATH
.
…sing links, and work on changes requested to the PR
✔️ Deploy Preview for odo-docusaurus-preview ready! 🔨 Explore the source changes: cf387b2 🔍 Inspect the deploy log: https://app.netlify.com/sites/odo-docusaurus-preview/deploys/60fad92e6cc08a0008317aa6 😎 Browse the preview: https://deploy-preview-4923--odo-docusaurus-preview.netlify.app |
|
||
### Installing odo on Windows | ||
1. Download the [odo-windows-amd64.exe](https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-windows-amd64.exe) file. | ||
2. Rename the downloaded file to odo.exe and move it to a folder of choice, for example C:\odo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. Rename the downloaded file to odo.exe and move it to a folder of choice, for example C:\odo | |
2. Rename the downloaded file to odo.exe and move it to a folder of choice, for example `C:\odo`. |
4. Click **New**, add the location where you copied the odo binary (e.g. `C:\odo` in [Step 2 of Installation](#installing-odo-on-windows) into the field or click **Browse** and select the directory, and click **OK**. | ||
|
||
#### Setting the PATH variable in Windows 7/8 | ||
1. Click **Start** and in the Search box types `Advance System Settings`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Click **Start** and in the Search box types `Advance System Settings`. | |
1. Click **Start** and in the Search box type `Advanced System Settings`. |
|
||
#### Setting the PATH variable in Windows 7/8 | ||
1. Click **Start** and in the Search box types `Advance System Settings`. | ||
2. Select **Advanced systems settings** and click the **Environment Variables** button at the bottom. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. Select **Advanced systems settings** and click the **Environment Variables** button at the bottom. | |
2. Select **Advanced Systems Settings** and click the **Environment Variables** button at the bottom. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems to be correct. See - https://www.groovypost.com/howto/set-path-system-variable-windows-7-8/
#### Setting the PATH variable in Windows 7/8 | ||
1. Click **Start** and in the Search box types `Advance System Settings`. | ||
2. Select **Advanced systems settings** and click the **Environment Variables** button at the bottom. | ||
3. Select the **Path** variable from the **System variable** section and click **Edit**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it really "System variable"? I don't know, so I'm asking. But I think it might be "System Variables".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure. I copy-pasted this from the old website.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is System variables
. See the 4th image here https://www.groovypost.com/howto/set-path-system-variable-windows-7-8/.
SonarCloud Quality Gate failed. 0 Bugs No Coverage information |
@feloy I'll let you decide about approving this PR. |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: feloy The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind documentation
What does this PR do / why we need it:
This PR adds odo installation docs.
Which issue(s) this PR fixes:
Fixes part of #4894
PR acceptance criteria:
Unit test
Integration test
Documentation
Update changelog
I have read the test guidelines
How to test changes / Special notes to the reviewer: