Skip to content
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

Reorganizes installation document #6086

Merged

Conversation

cdrage
Copy link
Member

@cdrage cdrage commented Sep 1, 2022

Reorganizes installation document

What type of PR is this:

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

Fixes #6082

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

@netlify
Copy link

netlify bot commented Sep 1, 2022

Deploy Preview for odo-docusaurus-preview ready!

Name Link
🔨 Latest commit 190b1ca
🔍 Latest deploy log https://app.netlify.com/sites/odo-docusaurus-preview/deploys/6318acfc3548430008294475
😎 Deploy Preview https://deploy-preview-6086--odo-docusaurus-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@odo-robot
Copy link

odo-robot bot commented Sep 1, 2022

Unit Tests on commit 611b72c finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 1, 2022

Validate Tests on commit 611b72c finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 1, 2022

Kubernetes Tests on commit 611b72c finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 1, 2022

OpenShift Tests on commit 611b72c finished successfully.
View logs: TXT HTML

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. label Sep 3, 2022
@cdrage cdrage force-pushed the rework-install-document branch from 30bb746 to 3721392 Compare September 6, 2022 12:58
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. label Sep 6, 2022
@odo-robot
Copy link

odo-robot bot commented Sep 6, 2022

Windows Tests (OCP) on commit 611b72c finished successfully.
View logs: TXT HTML

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

4. Add the binary to your `PATH`

## Visual Studio Code Plugin
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the VSCode Plugin currently installs odo v2, I was wondering if we shouldn't hide this section for now. When the VSCode Plugin migrates to v3, then we would consider adding this section back. Would even make more sense as part of the work to be done for #5674.
@kadel Any thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Considering this doc points to v3, I agree with Armel. It makes more sense to hide this section for now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brew also installs v2 of odo Mac, so 🤷

Let's get @kadel 's opinion on this

@cdrage
Copy link
Member Author

cdrage commented Sep 7, 2022

@rm3l @valaparthvi Updated, ready for another review 💯

@cdrage cdrage force-pushed the rework-install-document branch from a4926c1 to 9bb541e Compare September 7, 2022 14:38
<!--
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 redhat-developer#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>
Signed-off-by: Charlie Drage <charlie@charliedrage.com>
@cdrage cdrage force-pushed the rework-install-document branch from 9bb541e to 190b1ca Compare September 7, 2022 14:38
@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 7, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.6% 0.6% Duplication

Copy link
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Sep 7, 2022
@openshift-ci
Copy link

openshift-ci bot commented Sep 7, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rm3l

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. label Sep 7, 2022
@openshift-merge-robot openshift-merge-robot merged commit 7c53ffc into redhat-developer:main Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. lgtm Indicates that a PR is ready to be merged. Required by Prow.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rework installation documentation
4 participants