pingcap/tiflow

docs: update the document about canal protocol

Open

#730 opened on Jul 8, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (310 forks)auto 404
component/docshelp wanted

Repository metrics

Stars
 (461 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Review the existing documentation structure and add the specified sections about canal protocol. Look at the codebase for canal protocol implementation details to accurately describe functional differences.
Tech stack
go
Domain
backenddatabasedocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80