Skip to content

[SRVCOM-1115] Updating OCP 4.5 serverless docs to new OCP guidelines#28980

Merged
bobfuru merged 1 commit intoopenshift:enterprise-4.5from
abrennan89:OCPguidelines45
Feb 1, 2021
Merged

[SRVCOM-1115] Updating OCP 4.5 serverless docs to new OCP guidelines#28980
bobfuru merged 1 commit intoopenshift:enterprise-4.5from
abrennan89:OCPguidelines45

Conversation

@abrennan89
Copy link
Copy Markdown
Contributor

Cherry pick of #28975 for OCP 4.5

@openshift-ci-robot openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 29, 2021
@openshift-docs-preview-bot
Copy link
Copy Markdown

The preview will be available shortly at:

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

A few minor suggestions but otherwise LGTM

Comment thread modules/apiserversource-kn.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/binding and/binding, and

Comment thread modules/apiserversource-kn.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/Pod/pod

Comment thread modules/serverless-list-source.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/using/entering

Comment thread modules/serverless-pingsource-yaml.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/service's/service ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/URLs, however the/URLs; however, the

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It would be helpful to clarify what "it" is here, for example:

The ping source can be used as a timer and is created as a PingSource object.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Earlier, you had "Broker" capitalized, so pointing this out for consistency.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Should be lowercase everywhere so I'll check that, thanks

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I did a quick grep on this and I don't think it's capitalized now anywhere except in the YAML examples where it's referring to a specific API object type. Let me know if there are any specific instances you see that need to change please :)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

SGTM, thanks!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same as previous comment about "it"

@bobfuru bobfuru added the peer-review-done Signifies that the peer review team has reviewed this PR label Jan 29, 2021
@abrennan89 abrennan89 force-pushed the OCPguidelines45 branch 2 times, most recently from 10081da to cabf810 Compare February 1, 2021 17:19
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/Broker/broker?

@bobfuru bobfuru added this to the Next Release milestone Feb 1, 2021
@bobfuru bobfuru merged commit 69badf7 into openshift:enterprise-4.5 Feb 1, 2021
@abrennan89 abrennan89 deleted the OCPguidelines45 branch December 17, 2021 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.5 peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants