docs: update the document about canal protocol
Open
Nobody has claimed this yet.
component/docs
help wanted
- Dominant language
- Go
- Stars
- 464
- Forks
- 313
- Avg merge
- 4d 7h
- Merged PRs (30d)
- 14
Description
Feature Request
Is your feature request related to a problem? Please describe:
We already support the canal protocol in #649, but the documents about the canal are absently
We need to add the following documents:
- How to choose an output protocol
- What are the functional differences between the canal and open protocol
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing documentation for the canal and open protocols, then review the surrounding TiCDC documentation to determine where the new content belongs. Done means documenting how to choose an output protocol and explaining the functional differences between canal and open protocol.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100