-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Release notes for odo. #23388
Release notes for odo. #23388
Conversation
The preview will be available shortly at: |
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.
Everything else LGTM! @dharmit can you take a look too regarding the operator part?
---- | ||
+ | ||
or | ||
* The `--devfile` flag is added to `odo create`. Run `odo create <component name> --devfile <devfile path>` to specify your devfile location. |
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.
We may have to continue to list how to enable experimental support in order to use this.
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.
Added info about that.
---- | ||
|
||
* `{odo-title}` now supports Ingress to create URLs on Kubernetes. | ||
* The `--downloadSource` flag is added to `odo create`. Run `odo create nodejs --downloadSource <project-name>` to download a source code of a project specified in the devfile. If no project name is specified, `odo` downloads the first 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.
This is actually being renamed to --starter
in this PR: redhat-developer/odo#3425
Should we still have this in the release notes?
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.
Thanks! I've renamed it to --starter
. I see that the PR has been approved, any reasons it might not get merged and not make it into the release? If so, we can leave it out.
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.
Some minor edits and suggestions needed. Let us know when the update is complete and we can merge. Thanks.
---- | ||
+ | ||
or | ||
* The `--devfile` flag is added to `odo create`. Run `odo create <component name> --devfile <devfile path>` to specify your devfile location. This flag is only available in the Experimental Mode. See, xref:odo-technology-preview_odo-release-notes[Technology Preview features] to learn how to enable it. |
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.
s/See, xref/See xref/
---- | ||
|
||
* `{odo-title}` now supports Ingress to create URLs on Kubernetes. | ||
* The `--starter` flag is added to `odo create`. Run `odo create nodejs --starter <project-name>` to download a source code of a project specified in the devfile. If no project name is specified, `odo` downloads the first 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.
s/to download a source code of a project/to download the source code for a project/
* `{odo-title}` now supports Ingress to create URLs on Kubernetes. | ||
* The `--starter` flag is added to `odo create`. Run `odo create nodejs --starter <project-name>` to download a source code of a project specified in the devfile. If no project name is specified, `odo` downloads the first one. | ||
|
||
* The `--context` flag is added to `odo push`. With `--context` you can trigger `odo push` from outside the source code directory. Run `odo push --devfile <path to the devfile> --context <directory with your component>` to specify the directory of your component. |
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.
s/--context
you/--context
, you/
* `odo url delete --now` now works with the devfiles. | ||
* The `--debug` flag now works with the devfiles. | ||
|
||
* Added machine readable output for listing Operator backed services. Run `odo catalog list services -o json` to display information about Operators and services in a JSON format. |
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.
s/machine readable/machine-readable/
s/Operator backed/Operator-backed/
s/in a JSON format/in JSON format/
|
||
* Added machine readable output for listing Operator backed services. Run `odo catalog list services -o json` to display information about Operators and services in a JSON format. | ||
|
||
* Added machine readable output for debugging. Run `odo debug info -o json` to display the debugging information in a JSON format. |
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.
s/machine readable/machine-readable/
s/in a JSON format/in JSON format/
|
||
:FeatureName: Devfile support | ||
include::modules/technology-preview.adoc[leveloffset=+1] | ||
|
||
* Operators support. You can now create services from Operators with `{odo-title}`. To learn more, see xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc[Creating instances of services managed by Operators] To access this feature, you must enable experimental mode with `odo preference set experimental true`. |
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.
Earlier, you capitalized "experimental mode" so I'd capitalize here as well for consistency.
|
||
Create and modify custom registries. | ||
|
||
.Example using 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.
Is registry in this context a command? If so, I'd write "Example using the registry command". Otherwise, add an article: "Example using a/the registry"
|
||
.Example using registry | ||
---- | ||
# Add registry to the registry list |
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.
Add a registry?
# Add registry to the registry list | ||
odo registry add <registry name> <registry URL> | ||
|
||
# List registry in the registry list |
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.
List a registry?
# List registry in the registry list | ||
odo registry list | ||
|
||
# Delete registry from the registry list |
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.
Similar comment as above: "a registry" throughout the rest of these commands.
Feedback.
Changes look great, thanks! LGTM! |
/cherrypick enterprise-4.5 |
@bobfuru: new pull request created: #23428 In response to this:
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. |
Branch 4.5