[improve][doc] Add doc for builtin functions #18569
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
doc
cbornet
changed the title
tisonkun
reviewed
Nov 23, 2022
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.
site2/docs/functions-package-java.md
Outdated
Comment on lines
15
to
25
| :::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
Comment on lines
171
to
177
| 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 <[email protected]>
Co-authored-by: tison <[email protected]>
Co-authored-by: tison <[email protected]>
5 tasks
|
I removed usage of |
momo-jun
reviewed
Nov 24, 2022
momo-jun
reviewed
Nov 24, 2022
momo-jun
reviewed
Nov 24, 2022
| --- | ||
| 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
approved these changes
Nov 24, 2022
|
Merging... |
lifepuzzlefun
pushed a commit
to lifepuzzlefun/pulsar
that referenced
this pull request
Dec 9, 2022
Co-authored-by: tison <[email protected]>
lifepuzzlefun
pushed a commit
to lifepuzzlefun/pulsar
that referenced
this pull request
Jan 10, 2023
Co-authored-by: tison <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation
docdoc-requireddoc-not-neededdoc-completeMatching PR in forked repository
PR in forked repository: cbornet#9