[improve][doc]single source of truth for functions CLI and add a table for yml configs - #15389
Merged
Merged
Conversation
|
@momo-jun:Thanks for your contribution. For this PR, do we need to update docs? |
|
@momo-jun:Thanks for providing doc info! |
github-actions
Bot
added
the
doc
momo-jun
changed the title
Contributor
Author
|
Hi @freeznet @nlu90 can you pls review this doc PR? Thanks. |
momo-jun
changed the title
nlu90
reviewed
May 31, 2022
|
|
||
| You can configure a function by using a predefined a .yaml file. The following table outlines the required fields and arguments. | ||
|
|
||
| | Field Name | Nested Field | Type | Related Command Argument | Description | |
Member
There was a problem hiding this comment.
I suggest to put the Nested Field to the last column
Contributor
Author
There was a problem hiding this comment.
Nested fields have been moved to sub-tables for a clear view. PTAL.
Anonymitaet
reviewed
May 31, 2022
freeznet
approved these changes
Jun 2, 2022
Contributor
Author
|
Ping @Anonymitaet for review. |
Anonymitaet
approved these changes
Jun 7, 2022
1 task
Member
|
/pulsarbot run-failure-checks |
momo-jun
changed the title
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Motivation
As one of the actions to improve the doc set of Pulsar Functions, the motivation is to provide Pulsar users with a more user-centric, accurate, and comprehensive information experience.
Modifications
The preview looks good.
Documentation
doc(Your PR contains doc changes)