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

Create document highlighting dev and deploy #6120

Merged
merged 5 commits into from
Sep 21, 2022

Conversation

cdrage
Copy link
Member

@cdrage cdrage commented Sep 13, 2022

Create document highlighting dev and deploy

What type of PR is this:

/kind documentation

What does this PR do / why we need it:

  • Changes title of "Basics" to "Concepts" in concepts doc
  • Adds document on how to do dev vs deploy and which command you should
    use
  • Highlights when to use either command

Which issue(s) this PR fixes:

Closes #6083

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

@netlify
Copy link

netlify bot commented Sep 13, 2022

Deploy Preview for odo-docusaurus-preview ready!

Name Link
🔨 Latest commit 15b5ffd
🔍 Latest deploy log https://app.netlify.com/sites/odo-docusaurus-preview/deploys/632b46cb03822b00085a70d7
😎 Deploy Preview https://deploy-preview-6120--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.

@cdrage
Copy link
Member Author

cdrage commented Sep 13, 2022

When reviewing, please add any suggestions you have!

@odo-robot
Copy link

odo-robot bot commented Sep 13, 2022

Unit Tests on commit 7e48fe3 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 13, 2022

Validate Tests on commit 7e48fe3 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 13, 2022

OpenShift Tests on commit 7e48fe3 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 13, 2022

Kubernetes Tests on commit 7e48fe3 finished with errors.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Sep 13, 2022

Windows Tests (OCP) on commit 7e48fe3 finished with errors.
View logs: TXT HTML

@openshift-ci
Copy link

openshift-ci bot commented Sep 15, 2022

@cdrage: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/v4.11-integration-e2e 337a2c1 link true /test v4.11-integration-e2e

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

@kadel
Copy link
Member

kadel commented Sep 15, 2022

I think this is a good start. It addresses the most frequent confusion that I say.

/approve

@openshift-ci
Copy link

openshift-ci bot commented Sep 15, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kadel

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 15, 2022
@valaparthvi
Copy link
Contributor

/override OpenShift-Integration-tests/OpenShift-Integration-tests

@openshift-ci
Copy link

openshift-ci bot commented Sep 20, 2022

@valaparthvi: Overrode contexts on behalf of valaparthvi: 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.

Copy link
Contributor

@valaparthvi valaparthvi left a comment

Choose a reason for hiding this comment

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

Currently, the doc does not clarify what environment a user is supposed to work with from the beginning. I think it makes sense to clarify from the beginning that odo dev is supposed to work with a dev environment and odo deploy is supposed to work with a production-like environment. I would prefer talking about them before we list all the potential tasks.

@cdrage
Copy link
Member Author

cdrage commented Sep 21, 2022

Good suggestions! Thanks @valaparthvi and @rm3l

I've gone ahead and switched the sentences to be more grammatically correct and in lower case. Thanks!

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Sep 21, 2022
cdrage and others added 4 commits September 21, 2022 13:15

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
<!--
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:**

* Adds document on how to do dev vs deploy and which command you should
  use
* Highlights when to use either command

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

Closes redhat-developer#6083

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
Co-authored-by: Parthvi Vala <pvala@redhat.com>
Co-authored-by: Parthvi Vala <pvala@redhat.com>
Co-authored-by: Parthvi Vala <pvala@redhat.com>
Signed-off-by: Charlie Drage <charlie@charliedrage.com>
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Sep 21, 2022
@openshift-ci
Copy link

openshift-ci bot commented Sep 21, 2022

New changes are detected. LGTM label has been removed.

@cdrage
Copy link
Member Author

cdrage commented Sep 21, 2022

I rebased, so re-adding lgtm label

@cdrage cdrage added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Sep 21, 2022
@sonarqubecloud
Copy link

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.5% 0.5% Duplication

@cdrage
Copy link
Member Author

cdrage commented Sep 21, 2022

/override Kubernetes-Integration-Tests/Kubernetes-Integration-Tests

@openshift-ci
Copy link

openshift-ci bot commented Sep 21, 2022

@cdrage: Overrode contexts on behalf of cdrage: Kubernetes-Integration-Tests/Kubernetes-Integration-Tests

In response to this:

/override Kubernetes-Integration-Tests/Kubernetes-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.

@cdrage cdrage merged commit 5b1707a into redhat-developer:main Sep 21, 2022
kadel pushed a commit to kadel/odo that referenced this pull request Oct 3, 2022
* Create document highlighting dev and deploy

<!--
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:**

* Adds document on how to do dev vs deploy and which command you should
  use
* Highlights when to use either command

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

Closes redhat-developer#6083

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

* Update docs/website/docs/overview/dev_and_deploy.md

Co-authored-by: Parthvi Vala <pvala@redhat.com>

* Update docs/website/docs/overview/dev_and_deploy.md

Co-authored-by: Parthvi Vala <pvala@redhat.com>

* Update docs/website/docs/overview/dev_and_deploy.md

Co-authored-by: Parthvi Vala <pvala@redhat.com>

* switch to lowercase sentences

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

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
Co-authored-by: Parthvi Vala <pvala@redhat.com>
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.

Explain differences between odo dev and odo deploy
4 participants