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

Update the help usage for odo create and odo url create #3858

Merged

Conversation

cdrage
Copy link
Member

@cdrage cdrage commented Aug 27, 2020

What type of PR is this?

Uncomment only one /kind line, and delete the rest.
For example, > /kind bug would simply become: /kind bug

/kind cleanup
/kind documentation

What does does this PR do / why we need it:

Updates the --help in the following way:

Which issue(s) this PR fixes:

Fixes #3463

PR acceptance criteria:

How to test changes / Special notes to the reviewer:

odo create --help

and

odo url create --help

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

**What type of PR is this?**
> Uncomment only one ` /kind` line, and delete the rest.
> For example, `> /kind bug` would simply become: `/kind bug`

/kind cleanup
/kind documentation

**What does does this PR do / why we need it**:

Updates the `--help` in the following way:
 - Changes the `odo create --help` usage to a 1-sentence summary similar
 to every other command
 - Updates our documentation to remove any mention of crc for something
 more neutral (example.com) similar to kubectl / kubernetes
 documentation, for example: https://kubernetes.io/docs/concepts/services-networking/ingress/

**Which issue(s) this PR fixes**:

Fixes redhat-developer#3463

**PR acceptance criteria**:

- [X] Documentation

- [X] I have read the [test guidelines](https://github.com/openshift/odo/blob/master/docs/dev/test-architecture.adoc)

**How to test changes / Special notes to the reviewer**:

`odo create --help`

and

`odo url create --help`

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
@kadel
Copy link
Member

kadel commented Aug 28, 2020

/retest
/approve
/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Aug 28, 2020
@openshift-ci-robot
Copy link
Collaborator

[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-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. label Aug 28, 2020
@openshift-bot
Copy link

/retest

Please review the full test history for this PR and help us cut down flakes.

1 similar comment
@openshift-bot
Copy link

/retest

Please review the full test history for this PR and help us cut down flakes.

@codecov
Copy link

codecov bot commented Aug 28, 2020

Codecov Report

Merging #3858 into master will decrease coverage by 0.10%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3858      +/-   ##
==========================================
- Coverage   44.29%   44.19%   -0.11%     
==========================================
  Files         139      141       +2     
  Lines       13401    13600     +199     
==========================================
+ Hits         5936     6010      +74     
- Misses       6883     7007     +124     
- Partials      582      583       +1     
Impacted Files Coverage Δ
pkg/devfile/parser/data/common/command_helper.go 57.14% <0.00%> (-42.86%) ⬇️
pkg/config/env_var.go 46.77% <0.00%> (-16.27%) ⬇️
pkg/envinfo/envinfo.go 44.44% <0.00%> (-3.66%) ⬇️
pkg/devfile/adapters/common/utils.go 87.67% <0.00%> (-0.80%) ⬇️
pkg/service/service.go 36.23% <0.00%> (-0.22%) ⬇️
pkg/config/storage.go 95.34% <0.00%> (ø)
pkg/testingutil/devfile.go 0.00% <0.00%> (ø)
pkg/devfile/parser/data/2.0.0/components.go 39.03% <0.00%> (ø)
pkg/devfile/parser/configurables.go 57.25% <0.00%> (ø)
pkg/devfile/parser/representation.go 0.00% <0.00%> (ø)
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 627c2fc...762ed22. Read the comment docs.

@openshift-merge-robot openshift-merge-robot merged commit cb167c8 into redhat-developer:master Aug 28, 2020
@cdrage cdrage deleted the update-help-usage branch January 14, 2022 14:57
@rm3l rm3l added the area/refactoring Issues or PRs related to code refactoring label Jun 16, 2023
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. area/refactoring Issues or PRs related to code refactoring 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.

How to create a valid URL when using kubernetes in the backend?
6 participants