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

update quickstart #5992

Merged
merged 17 commits into from
Aug 1, 2022
Merged

Conversation

kadel
Copy link
Member

@kadel kadel commented Jul 29, 2022

What type of PR is this:
/kind documentation

What does this PR do / why we need it:

This addresses some of the feedback that we got from running the pilot testing party.

  • adds information about required to login to the OpenShift cluster first
  • adds information about creating new namespace before creating an application on the cluster
  • adds option to create Route for OpenShift instead of Ingress

@kadel kadel requested a review from cdrage July 29, 2022 16:00
@openshift-ci openshift-ci bot requested review from dharmit and feloy July 29, 2022 16:00
@netlify
Copy link

netlify bot commented Jul 29, 2022

Deploy Preview for odo-docusaurus-preview ready!

Name Link
🔨 Latest commit 31c4f9a
🔍 Latest deploy log https://app.netlify.com/sites/odo-docusaurus-preview/deploys/62e7e6a8ff09e90008d5ceab
😎 Deploy Preview https://deploy-preview-5992--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 Jul 29, 2022

Unit Tests on commit 501add2 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 29, 2022

Validate Tests on commit 501add2 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 29, 2022

Windows Tests (OCP) on commit 501add2 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 31, 2022

Kubernetes Tests on commit 501add2 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Jul 31, 2022

OpenShift Tests on commit 501add2 finished with errors.
View logs: TXT HTML

kadel and others added 4 commits August 1, 2022 14:00
Co-authored-by: Dharmit Shah <shahdharmit@gmail.com>
Co-authored-by: Dharmit Shah <shahdharmit@gmail.com>
Co-authored-by: Dharmit Shah <shahdharmit@gmail.com>
Co-authored-by: Dharmit Shah <shahdharmit@gmail.com>
@dharmit
Copy link
Member

dharmit commented Aug 1, 2022

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Aug 1, 2022
Co-authored-by: Philippe Martin <contact@elol.fr>
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Aug 1, 2022
kadel and others added 8 commits August 1, 2022 16:09
Co-authored-by: Philippe Martin <contact@elol.fr>
Co-authored-by: Philippe Martin <contact@elol.fr>
Co-authored-by: Philippe Martin <contact@elol.fr>
Co-authored-by: Philippe Martin <contact@elol.fr>
Co-authored-by: Philippe Martin <contact@elol.fr>
Co-authored-by: Philippe Martin <contact@elol.fr>
Co-authored-by: Philippe Martin <contact@elol.fr>
Co-authored-by: Philippe Martin <contact@elol.fr>
Co-authored-by: Philippe Martin <contact@elol.fr>
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Aug 1, 2022
@feloy
Copy link
Contributor

feloy commented Aug 1, 2022

/approve

@openshift-ci
Copy link

openshift-ci bot commented Aug 1, 2022

[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 /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 Aug 1, 2022
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.

LGTM after the changes already requested, but I had one last comment ^^

In "Step 4 (odo deploy)", it is currently written:

Your application has now been deployed to the Kubernetes cluster with Deployment, Service, and Ingress resources.

Test your application by visiting the DOMAIN_NAME variable that you had set in the devfile.yaml.

This seems relevant for Kubernetes only, since we are deploying a Route in Openshift. So maybe we should also have separate tabs for Kubernetes and Openshift, indicating how to access the application..

@kadel
Copy link
Member Author

kadel commented Aug 1, 2022

This seems relevant for Kubernetes only, since we are deploying a Route in Openshift. So maybe we should also have separate tabs for Kubernetes and Openshift, indicating how to access the application..

good catch. I'll change it

@rm3l
Copy link
Member

rm3l commented Aug 1, 2022

This seems relevant for Kubernetes only, since we are deploying a Route in Openshift. So maybe we should also have separate tabs for Kubernetes and Openshift, indicating how to access the application..

good catch. I'll change it

/hold

(Just to make sure the PR does not get merged before those changes are pushed)

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. Required by Prow. label Aug 1, 2022
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Aug 1, 2022
@kadel
Copy link
Member Author

kadel commented Aug 1, 2022

@rm3l new commit added. This also nicely highlights why we need #5990

@rm3l
Copy link
Member

rm3l commented Aug 1, 2022

This also nicely highlights why we need #5990

Indeed. This would be helpful.

Co-authored-by: Armel Soro <armel@rm3l.org>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 1, 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
1.3% 1.3% Duplication

</TabItem>
<TabItem value="openshift" label="OpenShift">

### Login to OpenShift Cluster
Copy link
Member

Choose a reason for hiding this comment

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

maybe put this in a different tab and show kubernetes 1st? we want to try to remain Kubernetes #1 and show that first, especially with CNCF presentations / advertising / etc.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure I understand this. The Kubernetes is always the first tab, and the OpenShift is the second. Or did I miss it somewhere?

Copy link
Member

Choose a reason for hiding this comment

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

Ah, I missed that part. I shouldn't be doing reviews on my day off, woops! When I went to preview it I hadn't seen it

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Aug 1, 2022
@rm3l rm3l removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. Required by Prow. label Aug 1, 2022
@kadel
Copy link
Member Author

kadel commented Aug 1, 2022

/override OpenShift Integration tests/OpenShift Integration tests

@openshift-ci
Copy link

openshift-ci bot commented Aug 1, 2022

@kadel: Overrode contexts on behalf of kadel: OpenShift Integration tests/OpenShift Integration tests

In response to this:

/override OpenShift Integration tests/OpenShift Integration tests

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-merge-robot openshift-merge-robot merged commit 854e756 into redhat-developer:main Aug 1, 2022
cdrage pushed a commit to cdrage/odo that referenced this pull request Aug 31, 2022
* update quickstart

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Dharmit Shah <shahdharmit@gmail.com>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Dharmit Shah <shahdharmit@gmail.com>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Dharmit Shah <shahdharmit@gmail.com>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Dharmit Shah <shahdharmit@gmail.com>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Philippe Martin <contact@elol.fr>

* add info about how to get url

* Update docs/website/docs/user-guides/quickstart.md

Co-authored-by: Armel Soro <armel@rm3l.org>

Co-authored-by: Dharmit Shah <shahdharmit@gmail.com>
Co-authored-by: Philippe Martin <contact@elol.fr>
Co-authored-by: Armel Soro <armel@rm3l.org>
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.

6 participants