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

[RHDEVDOCS-3297] Minor updates to serverless ODC docs #46792

Merged
merged 1 commit into from
Jun 16, 2022

Conversation

abrennan89
Copy link
Contributor

@abrennan89 abrennan89 commented Jun 16, 2022

Version(s):
OCP 4.8+

Issue:
https://issues.redhat.com/browse/RHDEVDOCS-3297

Link to docs preview:
Preview likely not required but can be added if necessary. This PR contains only very minor changes to text.
QE review also not required.

@abrennan89 abrennan89 added peer-review-needed Signifies that the peer review team needs to review this PR dev-tools Label for all Odo/Pipelines/Helm/Developer Console/Perspective PRs serverless Label for all Serverless PRs branch/enterprise-4.8 branch/enterprise-4.9 branch/enterprise-4.10 branch/enterprise-4.11 labels Jun 16, 2022
@abrennan89 abrennan89 added this to the Next Release milestone Jun 16, 2022
@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jun 16, 2022
Copy link
Contributor

@mjpytlak mjpytlak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. Left one suggestion behind.


. In the *Sink* section of the *Event Sources* form view, select *Resource*. Then use the drop-down list to select your sink.
. In the *Sink* section of the *Create Event Source* form view, select *Resource*. Then use the drop-down list to select your sink.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. In the *Sink* section of the *Create Event Source* form view, select *Resource*. Then use the drop-down list to select your sink.
. In the *Sink* section of the *Create Event Source* form view, select *Resource*. Then use the list to select your sink.

Per our UI guidance, we should refer to a drop-down list as simply "list". (https://docs.engineering.redhat.com/display/CCSENABLE/UI+elements)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this must be relatively new guidance because we had always previously used "drop-down" and it's used across all the serverless docs, but I will open a follow up Jira to update this in all our procedures.

It would be a bit out of scope to change this for this PR since the text wasn't added or modified for that, and it would also need to apply to a lot of other modules, and for versions as far back as 4.6 rather than just 4.8+, so I'll leave this for now but will follow it up as a batch change later.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened a follow up Jira for this https://issues.redhat.com/browse/SRVCOM-1918

@abrennan89 abrennan89 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jun 16, 2022
@abrennan89 abrennan89 merged commit 2982673 into openshift:main Jun 16, 2022
@abrennan89
Copy link
Contributor Author

/cherrypick enterprise-4.8

@abrennan89
Copy link
Contributor Author

/cherrypick enterprise-4.9

@abrennan89
Copy link
Contributor Author

/cherrypick enterprise-4.10

@abrennan89
Copy link
Contributor Author

/cherrypick enterprise-4.11

@openshift-cherrypick-robot

@abrennan89: new pull request created: #46805

In response to this:

/cherrypick enterprise-4.8

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.

@openshift-cherrypick-robot

@abrennan89: new pull request created: #46806

In response to this:

/cherrypick enterprise-4.9

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.

@openshift-cherrypick-robot

@abrennan89: new pull request created: #46807

In response to this:

/cherrypick enterprise-4.10

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.

@openshift-cherrypick-robot

@abrennan89: new pull request created: #46808

In response to this:

/cherrypick enterprise-4.11

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.

@abrennan89 abrennan89 deleted the RHDEVDOCS-3297 branch June 30, 2022 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.8 branch/enterprise-4.9 branch/enterprise-4.10 branch/enterprise-4.11 dev-tools Label for all Odo/Pipelines/Helm/Developer Console/Perspective PRs peer-review-done Signifies that the peer review team has reviewed this PR serverless Label for all Serverless PRs size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants