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

Blog post for v3-alpha1 #5710

Merged
merged 9 commits into from
May 5, 2022

Conversation

feloy
Copy link
Contributor

@feloy feloy commented May 2, 2022

What type of PR is this:

/kind documentation

TODO:

Preview: https://deploy-preview-5710--odo-docusaurus-preview.netlify.app/blog/odo-v3-alpha1-release/

@openshift-ci openshift-ci bot added 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 May 2, 2022
@netlify
Copy link

netlify bot commented May 2, 2022

Deploy Preview for odo-docusaurus-preview ready!

Name Link
🔨 Latest commit 98ad38c
🔍 Latest deploy log https://app.netlify.com/sites/odo-docusaurus-preview/deploys/62738bfa4c8e0d0008b26436
😎 Deploy Preview https://deploy-preview-5710--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.

@openshift-ci openshift-ci bot requested review from cdrage and kadel May 2, 2022 14:20
@odo-robot
Copy link

odo-robot bot commented May 2, 2022

Unit Tests on commit 9bd5826 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented May 2, 2022

Windows Tests (OCP) on commit 9bd5826 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented May 2, 2022

Kubernetes Tests on commit 9bd5826 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented May 2, 2022

OpenShift Tests on commit 9bd5826 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented May 2, 2022

Validate Tests on commit 9bd5826 finished successfully.
View logs: TXT HTML

docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
@feloy feloy requested a review from cdrage May 3, 2022 06:21
@feloy feloy force-pushed the blog-v3-alpha1 branch from e29273c to 882052f Compare May 4, 2022 06:21
@feloy feloy changed the title [wip] Blog post for v3-alpha1 Blog post for v3-alpha1 May 4, 2022
@openshift-ci 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 May 4, 2022
@feloy feloy requested a review from valaparthvi May 4, 2022 06:25
@feloy feloy force-pushed the blog-v3-alpha1 branch from 882052f to 8fb1c9e Compare May 4, 2022 06:59

`odo` is a tool that aims to simplify the life of developers working on cloud-native applications.

Thanks to the emergence of the [Devfile](https://devfile.io/) open standard, which has been accepted as a CNCF Sandbox project (January 2022), odo v3 is now entirely based on this open standard.
Copy link
Contributor

@valaparthvi valaparthvi May 4, 2022

Choose a reason for hiding this comment

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

odo v3 is now entirely based on this open standard.

Wasn't Odo always based on Devfile? I think it should be

Odo is entirely based on this open standard.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have added entirely, because v2 was already based on devfile, but also on s2i.

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.

Great work! I just have a few nitty-picky comments.


A single Devfile defines the smallest building block of an application, that a developer can: build, run, test, debug and deploy. In a cloud-native environment, we generally talk about a micro-service.

Firstly, the Devfile describes the container that is needed to be deployed on a cluster during the development phases, along with the commands to execute on this container to build, run, test and debug the program, assuming the sources have been synchronized into the container.
Copy link
Contributor

Choose a reason for hiding this comment

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

assuming the sources have been synchronized into the container.

What does this statement mean?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"expecting that the sources have been syncrhonized into the container (by odo)"

docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved

We can see through the previous example that a Devfile is generic enough, with only a few specific values, like the endpoints and the image names. A Devfile written for a specific language and framework can be used by most of the programs written using this language and framework, with minimum personalization.

A Devfile registry is available at https://registry.devfile.io, containing Devfile's for a large variety of languages and frameworks, and you can deploy your own registry to make accessible your own Devfile's.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
A Devfile registry is available at https://registry.devfile.io, containing Devfile's for a large variety of languages and frameworks, and you can deploy your own registry to make accessible your own Devfile's.
A Devfile registry is available at https://registry.devfile.io, containing Devfiles for a large variety of languages and frameworks, and you can deploy your own registry to make accessible your own Devfiles.
```

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Devfile's is the notation @cdrage has used in his review. I think he didn't want to add an s to an invariant name

Copy link
Contributor

Choose a reason for hiding this comment

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

What about this one?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved

The `odo init` command is the first command to use, before to start using `odo` with your project. The goal of this first step is to get a suitable Devfile for your project.

`odo init` will search for Devfile's in the Devfile registries. By default, `odo` is configured to access only one Devfile registry (the one specified above), and you can modify the Devfile registries `odo` is accessing using the command `odo preference registry`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`odo init` will search for Devfile's in the Devfile registries. By default, `odo` is configured to access only one Devfile registry (the one specified above), and you can modify the Devfile registries `odo` is accessing using the command `odo preference registry`.
`odo init` will search for Devfiles in the Devfile registries. By default, `odo` is configured to access only one Devfile registry (the one specified above), and you can modify the Devfile registries `odo` is accessing using the command `odo preference registry`.

docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
docs/website/blog/2022-05-02-odo-v3-alpha1.md Outdated Show resolved Hide resolved
@feloy feloy force-pushed the blog-v3-alpha1 branch from 3ff914a to 0a074e1 Compare May 5, 2022 06:41
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label May 5, 2022
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. Required by Prow. label May 5, 2022
@sonarqubecloud
Copy link

sonarqubecloud bot commented May 5, 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
No Duplication information No Duplication information

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

/lgtm
/approve

@openshift-ci
Copy link

openshift-ci bot commented May 5, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: valaparthvi

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 May 5, 2022
@openshift-merge-robot openshift-merge-robot merged commit 867a54f into redhat-developer:main May 5, 2022
cdrage added a commit to cdrage/odo that referenced this pull request Aug 31, 2022
* Blog post from dev.to/feloy

* Apply suggestions from code review

Review

Co-authored-by: Charlie Drage <[email protected]>

* Review

* Update docs/website/blog/2022-05-02-odo-v3-alpha1.md

Co-authored-by: Parthvi Vala <[email protected]>

* Rename demo section

* Add Parthvi as author

* Apply suggestions from code review

Co-authored-by: Parthvi Vala <[email protected]>

* Replaces Devfile's with Devfiles

* Remove unwanted text

Co-authored-by: Charlie Drage <[email protected]>
Co-authored-by: Parthvi Vala <[email protected]>
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.

5 participants