update the description of uri to make it more clear #387
Conversation
yangcao77
requested review from
amisevsk,
davidfestal and
sleshchenko
as code owners
yangcao77
force-pushed
the
update-uri-description
branch
from
c999e05 to
6fd226e
Compare
|
@yangcao77 I would also add desc to |
| @@ -21,7 +21,8 @@ type ImportReferenceUnion struct { | |||
| // +optional | |||
| ImportReferenceType ImportReferenceType `json:"importReferenceType,omitempty"` | |||
|
|
|||
| // Uri of a Devfile yaml file | |||
| // Uri Reference of a Devfile yaml file, can be an absolute http URL address | |||
| // or a relative Uri with the current devfile as the base Uri | |||
There was a problem hiding this comment.
Change Uri to URI in the comment
yangcao77
force-pushed
the
update-uri-description
branch
from
943f61a to
d7c55ce
Compare
|
@yangcao77: PR needs rebase. 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. |
Signed-off-by: Stephanie <[email protected]>
yangcao77
force-pushed
the
update-uri-description
branch
from
d7c55ce to
c170644
Compare
| @@ -5499,9 +5499,17 @@ spec: | |||
| - name | |||
| type: object | |||
| registryUrl: | |||
| description: Registry URL to pull devfile from with | |||
There was a problem hiding this comment.
Consider changing to:
"Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the regsitryURL when id is used."
(with registryURL and id` properly formated)
| type: string | ||
| uri: | ||
| description: Uri of a Devfile yaml file | ||
| description: URI Reference of a Devfile yaml file, can |
There was a problem hiding this comment.
Consider changing to:
"URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI."
Signed-off-by: Stephanie <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: amisevsk, elsony, yangcao77 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: Stephanie [email protected]
What does this PR do?
This PR updates the description of uri reference to make it more clear on the supported usage
What issues does this PR fix or reference?
Fixes #386
Is your PR tested? Consider putting some instruction how to test your changes
Docs PR