pingcap/tiflow

docs: update the document about canal protocol

Offen

#730 geöffnet am 08.07.2020

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (310 Forks)auto 404
component/docshelp wanted

Repository-Metriken

Stars
 (461 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Überprüfen Sie die vorhandene Dokumentationsstruktur und fügen Sie die angegebenen Abschnitte zum Canal Protokoll hinzu. Sehen Sie sich die Implementierungsdetails des Canal Protokolls in der Codebasis an, um die funktionalen Unterschiede genau zu beschreiben.
Tech Stack
go
Domain
backenddatabasedocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80