Add odo installation docs #4923

valaparthvi · 2021-07-19T18:03:24Z

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:

How to test changes / Special notes to the reviewer:

$ cd website/docs
# if you are doing it for the first time
$ npm install # this command installs dependencies required to create the website
$ npm run start

Go to Getting Started > Installations

website/docs/getting-started/installation.md

feloy · 2021-07-22T16:16:33Z

website/docs/getting-started/installation.md

+```
+5. Run the command to verify that it was installed properly.
+```shell
+odo


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.

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 in PATH.

./odo would this also be true for windows?

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 in PATH.

But the step make install has installed odo in $GOPATH/bin, which is, probably, in the PATH

But the step make install has installed odo in $GOPATH/bin, which is, probably, in the PATH

Ah. Totally missed that. I use make && cp -f odo ~/bin/odo on my local system so I was under that mindset.

I am a little confused about this discussion. Does the current content look okay?

website/docs/getting-started/installation.md

dharmit · 2021-07-23T09:42:38Z

website/docs/getting-started/installation.md

+```
+5. Run the command to verify that it was installed properly.
+```shell
+odo


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 in PATH.

…sing links, and work on changes requested to the PR

netlify · 2021-07-23T12:42:11Z

✔️ 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

website/docs/getting-started/installation.md

dharmit · 2021-07-23T14:34:45Z

website/docs/getting-started/installation.md

+
+### 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


Suggested change

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`.

dharmit · 2021-07-23T14:35:11Z

website/docs/getting-started/installation.md

+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`.


Suggested change

1. Click **Start** and in the Search box types `Advance System Settings`.

1. Click **Start** and in the Search box type `Advanced System Settings`.

dharmit · 2021-07-23T14:35:43Z

website/docs/getting-started/installation.md

+
+#### 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.


Suggested change

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.

It seems to be correct. See - https://www.groovypost.com/howto/set-path-system-variable-windows-7-8/

dharmit · 2021-07-23T14:36:27Z

website/docs/getting-started/installation.md

+#### 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**.


Is it really "System variable"? I don't know, so I'm asking. But I think it might be "System Variables".

I am not sure. I copy-pasted this from the old website.

It is System variables. See the 4th image here https://www.groovypost.com/howto/set-path-system-variable-windows-7-8/.

sonarcloud · 2021-07-23T15:00:14Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
6.3% Duplication

dharmit · 2021-07-26T10:30:01Z

@feloy I'll let you decide about approving this PR.

feloy · 2021-07-27T07:57:25Z

/approve

openshift-ci · 2021-07-27T07:57:36Z

[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:

~~OWNERS~~ [feloy]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. Required by Prow. kind/documentation needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. labels Jul 19, 2021

openshift-ci bot requested review from anandrkskd and mohammedzee1000 July 19, 2021 18:03

Add odo installation docs

6fe84c7

valaparthvi force-pushed the installation-docs branch from f3de5a4 to 6fe84c7 Compare July 19, 2021 18:06

openshift-ci bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. label Jul 19, 2021

valaparthvi mentioned this pull request Jul 19, 2021

Add "Getting Started" docs to the docusaurus based docs site #4894

Closed

9 tasks

valaparthvi requested review from feloy and dharmit July 19, 2021 18:07

valaparthvi changed the title ~~WIP: Add odo installation docs~~ Add odo installation docs Jul 22, 2021

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. Required by Prow. label Jul 22, 2021

valaparthvi mentioned this pull request Jul 22, 2021

Add Tutorials section to doc website #4934

Merged

5 tasks

feloy reviewed Jul 22, 2021

View reviewed changes

dharmit suggested changes Jul 23, 2021

View reviewed changes

openshift-ci bot assigned dharmit Jul 23, 2021

Remove individual installtion sections, organize code blocks, add mis…

86e3fae

…sing links, and work on changes requested to the PR

feloy reviewed Jul 23, 2021

View reviewed changes

website/docs/getting-started/installation.md Show resolved Hide resolved

dharmit suggested changes Jul 23, 2021

View reviewed changes

website/docs/getting-started/installation.md Outdated Show resolved Hide resolved

website/docs/getting-started/installation.md Outdated Show resolved Hide resolved

website/docs/getting-started/installation.md Outdated Show resolved Hide resolved

Change the release link

9212701

dharmit suggested changes Jul 23, 2021

View reviewed changes

Fix typos for windows installation

cf387b2

dharmit approved these changes Jul 23, 2021

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jul 23, 2021

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. label Jul 27, 2021

openshift-merge-robot merged commit b2ca2a8 into redhat-developer:main Jul 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add odo installation docs #4923

Add odo installation docs #4923

valaparthvi commented Jul 19, 2021

feloy Jul 22, 2021

dharmit Jul 23, 2021

valaparthvi Jul 23, 2021

feloy Jul 23, 2021

dharmit Jul 23, 2021

valaparthvi Jul 23, 2021

dharmit Jul 23, 2021

dharmit Jul 23, 2021

netlify bot commented Jul 23, 2021 •

edited

Loading

dharmit Jul 23, 2021

dharmit Jul 23, 2021

dharmit Jul 23, 2021

valaparthvi Jul 23, 2021

dharmit Jul 23, 2021

valaparthvi Jul 23, 2021

valaparthvi Jul 23, 2021

sonarcloud bot commented Jul 23, 2021

dharmit commented Jul 26, 2021

feloy commented Jul 27, 2021

openshift-ci bot commented Jul 27, 2021

	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`.

	1. Click Start and in the Search box types `Advance System Settings`.
	1. Click Start and in the Search box type `Advanced System Settings`.

	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.

Add odo installation docs #4923

Add odo installation docs #4923

Conversation

valaparthvi commented Jul 19, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Jul 23, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Jul 23, 2021

dharmit commented Jul 26, 2021

feloy commented Jul 27, 2021

openshift-ci bot commented Jul 27, 2021

netlify bot commented Jul 23, 2021 •

edited

Loading