-
Notifications
You must be signed in to change notification settings - Fork 244
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
Blog post for v3-alpha1 #5710
Conversation
✅ Deploy Preview for odo-docusaurus-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
||
`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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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)"
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. | |
``` |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about this one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll use Devfiles instead: https://createteachinspire.com/proper-nouns-plural-possessive/
|
||
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`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`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`. |
Review Co-authored-by: Charlie Drage <[email protected]>
Co-authored-by: Parthvi Vala <[email protected]>
Co-authored-by: Parthvi Vala <[email protected]>
Kudos, SonarCloud Quality Gate passed! |
/lgtm |
[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 |
* 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]>
What type of PR is this:
/kind documentation
TODO:
Preview: https://deploy-preview-5710--odo-docusaurus-preview.netlify.app/blog/odo-v3-alpha1-release/