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

Release notes for odo. #23388

Merged
merged 1 commit into from
Jul 2, 2020
Merged

Release notes for odo. #23388

merged 1 commit into from
Jul 2, 2020

Conversation

yhontyk
Copy link
Contributor

@yhontyk yhontyk commented Jun 30, 2020

Branch 4.5

@openshift-ci-robot openshift-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 30, 2020
@openshift-docs-preview-bot

The preview will be available shortly at:

@openshift-ci-robot openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 1, 2020
@yhontyk yhontyk changed the title [WIP] Release notes for odo. Release notes for odo. Jul 1, 2020
@openshift-ci-robot openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 1, 2020
Copy link
Contributor

@cdrage cdrage left a 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.
Copy link
Contributor

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.

Copy link
Contributor Author

@yhontyk yhontyk Jul 2, 2020

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.
Copy link
Contributor

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?

Copy link
Contributor Author

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.

@openshift-ci-robot openshift-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 2, 2020
@bobfuru bobfuru added this to the Next Release milestone Jul 2, 2020
@bobfuru bobfuru self-requested a review July 2, 2020 14:57
Copy link
Contributor

@bobfuru bobfuru left a 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.
Copy link
Contributor

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.
Copy link
Contributor

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.
Copy link
Contributor

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.
Copy link
Contributor

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.
Copy link
Contributor

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`.
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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.
@bobfuru
Copy link
Contributor

bobfuru commented Jul 2, 2020

Changes look great, thanks! LGTM!

@bobfuru bobfuru merged commit ad655a7 into openshift:master Jul 2, 2020
@bobfuru
Copy link
Contributor

bobfuru commented Jul 2, 2020

/cherrypick enterprise-4.5

@openshift-cherrypick-robot

@bobfuru: new pull request created: #23428

In response to this:

/cherrypick enterprise-4.5

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.5 size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants