Skip to content
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

tools, toc: reorganize TiDB Binlog documents #1078

Merged
merged 63 commits into from
May 5, 2019
Merged

tools, toc: reorganize TiDB Binlog documents #1078

merged 63 commits into from
May 5, 2019

Conversation

ericsyh
Copy link
Contributor

@ericsyh ericsyh commented Apr 24, 2019

What's PR background.

The current tidb-binlog put everything in one page, which is not so friendly to users.

What had done in this PR.

I split the previous documents into the overview, deploy, upgrade, operation and monitor 5 parts.

To-do List

Add FAQ troubleshooting documents for Binlog
Binlog cluster scale up/down documents

And docs-cn PR link: pingcap/docs-cn#1264

@ericsyh ericsyh requested a review from lilin90 April 24, 2019 03:45
@ericsyh ericsyh added the type/refactor The issue belongs to a refactor work. label Apr 28, 2019
@ericsyh
Copy link
Contributor Author

ericsyh commented Apr 29, 2019

@lilin90 @GregoryIan @csuzhangxc @WangXiangUSTC PTAL.

tools/binlog/deploy.md Outdated Show resolved Hide resolved
tools/binlog/deploy.md Outdated Show resolved Hide resolved
@IANTHEREAL
Copy link
Contributor

structure is LGTM

@IANTHEREAL
Copy link
Contributor

if there are too many content need to be adjusted, I think we can just refine the structure in this pr, and do others later @lilin90

TOC.md Outdated Show resolved Hide resolved
TOC.md Outdated Show resolved Hide resolved
tools/binlog/binlog-slave-client.md Outdated Show resolved Hide resolved
tools/binlog/deploy.md Outdated Show resolved Hide resolved
tools/binlog/deploy.md Outdated Show resolved Hide resolved
tools/binlog/operation.md Outdated Show resolved Hide resolved
tools/binlog/operation.md Outdated Show resolved Hide resolved
tools/binlog/tidb-binlog-kafka.md Outdated Show resolved Hide resolved
tools/binlog/tidb-binlog-local.md Outdated Show resolved Hide resolved
tools/binlog/upgrade.md Outdated Show resolved Hide resolved
tools/binlog/binlog-slave-client.md Outdated Show resolved Hide resolved
tools/binlog/deploy.md Outdated Show resolved Hide resolved
tools/binlog/deploy.md Outdated Show resolved Hide resolved
tools/binlog/monitor.md Outdated Show resolved Hide resolved
tools/binlog/monitor.md Outdated Show resolved Hide resolved
tools/binlog/overview.md Outdated Show resolved Hide resolved
tools/binlog/tidb-binlog-local.md Outdated Show resolved Hide resolved
tools/binlog/tidb-binlog-local.md Outdated Show resolved Hide resolved
tools/binlog/upgrade.md Outdated Show resolved Hide resolved
tools/binlog/upgrade.md Outdated Show resolved Hide resolved
tools/binlog/deploy.md Outdated Show resolved Hide resolved
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ericsyh ericsyh merged commit 15cab3d into pingcap:master May 5, 2019
@ericsyh ericsyh deleted the reorganize-TiDB-Binlog-documents branch May 5, 2019 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/refactor The issue belongs to a refactor work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants