-
Notifications
You must be signed in to change notification settings - Fork 113
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
docs: fix formatting and order of contribution guide content #3880
Open
gitcommitshow
wants to merge
9
commits into
develop
Choose a base branch
from
docs-contrib-guide
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
10ed160
docs: fix formatting and order of contribution guide content
gitcommitshow 27373c1
docs: toc for source integration development guide
gitcommitshow e687023
docs: add doc in guide to develop destination integration
gitcommitshow 6799bd1
docs: separate anchor tags for similar headings
gitcommitshow 7193c2d
docs: change procworkflow example order for better understanding
gitcommitshow 1354b28
docs: fix formatting of nested bullet points
gitcommitshow 96ec59b
docs: readability of a contribution guide section
gitcommitshow 36a0c74
docs: improve destination test example in contrib guide
gitcommitshow 90a86d5
docs: add hints for v1 source preference over v0 in contrib guide
gitcommitshow File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As v0 API got deprecated now, we can suggest to write in v1 spec
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed it. Now we are directing contributors towards
src/v1/sources
for source integration. But we still use example ofv0
source integration.@krishna2020 What are the key differences between
v0
vsv1
source integration a contributor must know? Context: Currently, I am using a v0 source integration example (Slack) in this guide, I want to understand what additional changes are required in the guide given that now we've updated steps to direct contributors towardssrc/v1
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another follow up question: Are we planning to migrate current v0 sources to v1?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
v1 will additionally have source config also as an input along with the event
We already highlighted this in the recent server transformer matrix docs
Yes, migration for v0 sources is also in the plan
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Understood. The difference is in the
process
function signature (arguments)v0
-process(event)
v1
-process({ event: eventData, source: sourceConfigData }
v2
, we will replaceevent
withrequest
And the output type is same in all these versions?
So the best solution is to simply use v1 source example to avoid any confusion. Which will require a major change in the first section of this content. How about we merge this PR for now, and then I raise another PR replacing v0 source example with v1 source example?