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

Adding initial doc for func subscribe #5754

Merged
merged 5 commits into from
Nov 10, 2023

Conversation

matzew
Copy link
Member

@matzew matzew commented Nov 9, 2023

Proposed Changes

  • Initial documentation for func subscribe

Copy link

netlify bot commented Nov 9, 2023

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit d25f299
🔍 Latest deploy log https://app.netlify.com/sites/knative/deploys/654dd503199a260008608ffe
😎 Deploy Preview https://deploy-preview-5754--knative.netlify.app/docs/functions/subscribing-functions
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@knative-prow knative-prow bot requested review from nainaz and skonto November 9, 2023 11:23
@knative-prow knative-prow bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 9, 2023
@matzew
Copy link
Member Author

matzew commented Nov 9, 2023

@lkingland here is my initial doc PR

```

!!! note
When invoking `func deploy` the CLI will create Knative Triggers for the function.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd move this note above the code blocks, line no. 7 of the .md file. Otherwise looks OK to me.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've separated that now, and added a more dedicated section, with a smalll focus on the deployment.

Moving the note to far up seems a bit odd to me...

Signed-off-by: Matthias Wessendorf <[email protected]>
Signed-off-by: Matthias Wessendorf <[email protected]>
Signed-off-by: Matthias Wessendorf <[email protected]>
Signed-off-by: Matthias Wessendorf <[email protected]>
Signed-off-by: Matthias Wessendorf <[email protected]>
@matzew matzew force-pushed the add_func_subscribe_doc branch from 9711b37 to d25f299 Compare November 10, 2023 07:00
@dsimansk
Copy link
Contributor

/approve
/lgtm

@matzew @lkingland adding both labels & hold to merge on demand. :)
/hold

@knative-prow knative-prow bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 10, 2023
@knative-prow knative-prow bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Nov 10, 2023
Comment on lines 35 to 37
!!! note
When invoking `func deploy` the CLI will create Knative Triggers for the function.

Copy link
Contributor

Choose a reason for hiding this comment

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

@matzew have you intentionally removed the note box?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, I have. please see the rendered page

Copy link
Member

@lkingland lkingland left a comment

Choose a reason for hiding this comment

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

Looks clean and to the point 👍🏻 ❤️ Thanks for the docs!

Copy link

knative-prow bot commented Nov 10, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dsimansk, lkingland, matzew

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

@matzew
Copy link
Member Author

matzew commented Nov 10, 2023

/unhold

@knative-prow knative-prow bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 10, 2023
@knative-prow knative-prow bot merged commit f68510c into knative:main Nov 10, 2023
16 checks passed
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. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants