[improve][doc] Add doc for builtin functions#18569
Conversation
github-actions
bot
added
the
doc
cbornet
changed the title
There was a problem hiding this comment.
Thanks for your contribution @cbornet! Comments inline.
Also, you need to add the functions-deploy-cluster-builtin doc to sidebars.json so that it shows on the sidebar.
BTW, you can read the Preview Guide to preview locally.
| :::note | ||
|
|
||
| If you plan to package and distribute your function for others to use, you are obligated to | ||
| license and copyright your own code properly. Remember to add the license and copyright to | ||
| all libraries your code uses and to your distribution. | ||
|
|
||
| ::: | ||
|
|
||
| > If you use the [NAR](#package-as-nar) method, the NAR plugin | ||
| automatically creates a `DEPENDENCIES` file in the generated NAR package, including the proper | ||
| licensing and copyrights of all libraries of your function. |
There was a problem hiding this comment.
They seem similar notes/tips, why different syntax?
You may read the syntax guide (https://pulsar.apache.org/contribute/document-syntax/#admonitions) for what is expected here.
site2/docs/functions-package-java.md
Outdated
| You must also create a `resources/META-INF/services/pulsar-io.yaml` file. In the following code sample, the value of `functionClass` is your function class name. The `name` is the one used when the Function is deployed as a [built-in](functions-deploy-cluster-builtin.md) one. | ||
|
|
||
| ```yaml | ||
| name: java-function | ||
| description: my java function | ||
| functionClass: org.example.test.ExclamationFunction | ||
| ``` |
Co-authored-by: tison <wander4096@gmail.com>
Co-authored-by: tison <wander4096@gmail.com>
Co-authored-by: tison <wander4096@gmail.com>
|
I removed usage of |
| --- | ||
| id: functions-deploy-cluster-builtin | ||
| title: Built-in functions | ||
| sidebar_label: "Built-in functions" |
There was a problem hiding this comment.
It's a task-oriented topic for users. So it makes more sense to use an imperative title, like Use built-in functions.
momo-jun
left a comment
momo-jun
left a comment
There was a problem hiding this comment.
LGTM.
Thanks for adding the docs. It deserves a feature rather than Improve in the PR title :)
|
Merging... |
Co-authored-by: tison <wander4096@gmail.com>
Co-authored-by: tison <wander4096@gmail.com>
3 participants
Documentation
docdoc-requireddoc-not-neededdoc-completeMatching PR in forked repository
PR in forked repository: cbornet#9