search

knative / func

Knative Functions client API and CLI
Apache License 2.0
274 stars 138 forks source link

Improve the getting started docs #335

Open jcrossley3 opened 3 years ago

jcrossley3 commented 3 years ago

I don't think the getting started tutorial goes far enough. Ideally, there'd be a clear, concise description of how to trigger the function from a VERY SIMPLE event source.

The user shouldn't be required to spend any brain cycles understanding the domain of some pre-existing, sophisticated example, e.g. an image processing pipeline is cool, but i don't care about processing images. Essentially, I already have an event source in mind, but I know nothing of knative: can you show me a minimal yaml file that I can use as a template to tie my source to my function?

It may not be possible without first improving the knative-eventing docs, but even a link to what's currently there would be an improvement. curl is handy, but insufficient for getting started with functions.

lance commented 3 years ago

@jcrossley3 if you would like to contribute thoughts or review existing work that is attempting to address this issue, please do! https://github.com/boson-project/func/pull/332

jcrossley3 commented 3 years ago

@jcrossley3 if you would like to contribute thoughts or review existing work that is attempting to address this issue, please do! #332

332 appears to be a nicer curl, and that will be handy, but if I need a rocket and you replace my toyota with a ferrari, I'm still not getting to the moon. ;)

This issue is about enhancing the getting started guide with a real working event source, hopefully with enough detail that a novice knative user could map an example event source to the real event source from which they want to trigger their function.

github-actions[bot] commented 3 years ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

github-actions[bot] commented 2 weeks ago

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.