toc: optimize the document directory structure #1279

scsldb · 2019-04-25T08:03:08Z

No description provided.

CLAassistant · 2019-04-25T08:03:16Z

All committers have signed the CLA.

lilin90 · 2019-04-25T09:15:28Z

TOC.md


 ## 目录

 + [关于 TiDB](overview.md)
+


@YiniXu9506 Is it acceptable to leave a blank line here? @scsldb Actually, I think this blank line is unnecessary.

@scsldb @lilin90 Please remove the blank line here. Thanks!

QueenyJin · 2019-04-25T09:27:54Z

LGTM.

lilin90 · 2019-04-26T02:43:04Z

TOC.md

+    + 配置参数
+      + [PD](op-guide/pd-configuration.md)
+      + [TiDB](op-guide/configuration.md)
+      + [TiKV](op-guide/tikv-configuration.md)
  + 安全
    - [与 MySQL 的安全特性差异](sql/security-compatibility.md)


@scsldb This file is also put under "参考手册 - 安全". I think we only need to keep one?

I recommend deleting "与 MySQL 的安全特性差异","TiDB 数据库权限管理","TiDB 用户账户管理" and keeping other

@scsldb OK. Then you can update it in this PR.

lilin90 · 2019-04-26T02:44:58Z

TOC.md

+      - [事务模型](sql/transaction-model.md)
+      - [隔离级别](sql/transaction-isolation.md)
+    - 系统表
+        - [mysql](sql/system-database.md)


@scsldb Would it be better to change mysql to TiDB 系统表 (which is more accurate)?

"mysql" is system database, currently, cannot be changed

@scsldb But this document is all about "系统表": https://pingcap.com/docs-cn/sql/system-database/

The old document have some problems, there is no specific system database,eg mysql, information_schema

TOC.md

dcalvin · 2019-04-26T08:44:58Z

TOC.md

+    + 配置参数
+      - [PD](op-guide/pd-configuration.md)
+      - [TiDB](op-guide/configuration.md)
+      - [TiKV](op-guide/tikv-configuration.md)
  + 安全
    - [与 MySQL 的安全特性差异](sql/security-compatibility.md)
    - [TiDB 数据库权限管理](sql/privilege.md)


The same as above. Should only keep one

morgo · 2019-05-08T05:21:33Z

@scsldb could you please describe the changes so I can try and compare to the en docs TOC?

Related PR: pingcap#1279

* toc, support: reorganize TOC and update a link Related PR: #1279 * toc: udpate description * toc: update wording

lilin90 · 2019-05-13T07:38:23Z

The changes have been updated in #1320, so I'll close this PR.

* sql: update tidb slow log operation * update log * update log * modify the translation: requirements vs recommendations * improve the translation * dm: add description for task overview monitor * dm: add description for instances' monitor * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * dm: address comments * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * v2.1/tools, v2.1/tools: update TiDB-Binlog (#1245) v2.1/tools: update TiDB-Binlog * fix incorrect IP address parsing and other inline code formatting * *: move overview and features (#1253) Via: pingcap/docs#1045 * TOC: update the quickstart link (#1255) * sql: remove redundant content in privilege && user, tiny clean up * Apply suggestions from code review Co-Authored-By: dcalvin <[email protected]> * Apply suggestions from code review Co-Authored-By: dcalvin <[email protected]> * Update tools/dm/monitor.md Co-Authored-By: csuzhangxc <[email protected]> * dm: address comments * add digest declare * update eg * add stats eg * update eg * address comment and add more field * TOC: covert docs-cn to DITA TOC (#1242) * TOC: covert docs-cn to DITA TOC * TOC: update wording * TOC: refine wording * toc: update description and a link * toc: update wording * toc: update a file name * toc: remove the K8s link * toc: fix a link about incremental replication * toc: update a blog post link to Chinese version * toc: fix a link and update wording * toc: update key features and overview * toc: update About TiDB * add declare for v2.1.8 * address comment * change the link of back-restore in tidb-binlog document * address comment * *: remove doc redundant space * sql/slow_query: add pt-digest-query version * tools: update a lightning download link * address comment * sql, TOC: update doc title (#1262) * benchmark: update the Note format * op-guide: update the Note format * benchmark, op-guide: Update the Note format (#1273) benchmark, op-guide: update the Note format * *: update the Note format * address comment * *: update the Note format * benchmark, v2.1/benchmark: remove an invalid link (#1275) * benchmark: remove an invalid link * v2.1/benchmark: remove an invalid link * update condition (#1265) * Update sql/slow-query.md Co-Authored-By: crazycs520 <[email protected]> * Update sql/slow-query.md Co-Authored-By: crazycs520 <[email protected]> * sql: update the USE command explanation in util document (#1269) * docs-cn #1112 Update the USE command explanation in util document * Update sql/util.md LGTM Co-Authored-By: ericsyh <[email protected]> * Update v1.0/sql/util.md LGTM Co-Authored-By: ericsyh <[email protected]> * Update v2.0/sql/util.md LGTM Co-Authored-By: ericsyh <[email protected]> * Update v2.1/sql/util.md LGTM Co-Authored-By: ericsyh <[email protected]> * update the loader pprof-addr default port (#1256) * tools: clarify meaning of "N/A" (#1267) * releases: correct the TiDB-Ansible version (#1280) * sql: fix some format mistakes (#1277) * Sql: fix some format mistakes * Update sql/slow-query.md Co-Authored-By: IzabelWang <[email protected]> * Update sql/slow-query.md Co-Authored-By: IzabelWang <[email protected]> * Update sql/slow-query.md Co-Authored-By: IzabelWang <[email protected]> * Update op-guide/tidb-config-file.md Co-Authored-By: IzabelWang <[email protected]> * Update sql/slow-query.md Co-Authored-By: IzabelWang <[email protected]> * Remove unnecessary space * Update slow-query.md * Update slow-query.md * sql: update generated columns docs * address comment and add issue link * *: rename how-to get started (#1281) * *: rename how-to get started Related PR: pingcap/docs#1046 * *: fix aliases link path * sql: update content structure and wording (#1259) * TOC: update a doc title (#1285) * tools/lightning: fix a broken link (#1287) * explain for update statement (#1284) * tools, toc: reorganize TiDB Binlog documents (#1264) * reorg the binlog documents * update TOC format * change the pd to file in overview * update the ansible-deployment link * rename the previous version of tidb-binlog to tidb-binlog-local * Make the explaination of pausing and paused more clear * change the order in TOC * uncomment some necessary configs in kafka version * add more explaination of paused and offline in overview * fix the typo * Add the Topic config in Kafka driver * update the gc intro in deployment * remove unnecessary step in deployment * remove the compression in deploy document * remove sql in the file dainer * update the download link in deployment * Time and size limits delete * abandon enable-tolerant config * move the reparo document into binlog folder * update the rapero download link * update drainer_pd to drainer_file * trouble-shooting: update the issue report link (#1289) * trouble-shooting: update the issue report link * Update trouble-shooting.md Co-Authored-By: CaitinChen <[email protected]> * Update trouble-shooting.md Co-Authored-By: CaitinChen <[email protected]> * Update trouble-shooting.md Co-Authored-By: CaitinChen <[email protected]> * tools/binlog: optimize the TiDB-Binlog documents (#1291) * fix some problems with suggestions from Lilian and Calvin * tools/binlog: fix and update format (#1292) * tools/binlog: fix and update format * tools/binlog: update wording * tools/binlog: update a link * Update tools/binlog/upgrade.md Co-Authored-By: lilin90 <[email protected]> * tools: update syncer batch size (#1288) * tools/dm: fix the error in valus from ansible command (#1293) * sql: fix punctuation and format * circle.yml: [WIP] comment publish pdf cmd * TOC, releases: add 2.1.9 release notes (#1298) * TOC, releases: add 2.1.9 release notes PTAL * Update 2.1.9.md * releases: fix format * tools: update loader status addr (#1299) * Add charset check in Syncer precheck (#1300) * Add charset check in Syncer precheck * Update tools/syncer.md Co-Authored-By: ericsyh <[email protected]> * circle.yml: remove IP address (#1301) * *: change "登陆" to “登录” (#1302) * sql: fix format (#1303) * sql: update a comma (#1305) * sql: replace "jeffrey" with "test" (#1309) * op-guide/monitor: update the PD API DOC link (#1311) * Update the link * Update the PD API DOC link * tools: fix the format error in Syncer (#1306) * Fix the format error in Syncer * Update tools/syncer.md Co-Authored-By: ericsyh <[email protected]> * update a link (#1313) * op-guide: add a guide about upgrading to 3.0 (#1258) * Add rolling update TiDB 3.0 guide. * Add rolling update TiDB 3.0 guide. * Apply suggestions from code review Co-Authored-By: superlzs0476 <[email protected]> * Apply suggestions from code review * Apply suggestions from code review Co-Authored-By: liubo <[email protected]> * op-guide: update a note format * op-guide: update wording * op-guide: update format * circle.yml: add a new IP for qiniu (#1315) * sql: fix typo (#1286) * media, tools: update TiDB-Lightning architecture Via: pingcap/docs#1128 * Delete useless instruction (#1308) * TOC, releases: add TiDB 3.0.0 RC1 release notes (#1316) * TOC, releases: add TiDB 3.0.0 RC1 release notes PTAL * Fix format * add new updates * Update TOC.md * Update rn.md * op-guide, toc: fix upgrade wording and update TOC (#1318) * op-guide, tools: fix a link and remove duplicated file (#1319) * *: update version limit for DM/Syncer (#1312) * toc, support: reorganize TOC and update a link (#1320) * toc, support: reorganize TOC and update a link Related PR: #1279 * toc: udpate description * toc: update wording * *: rename how-to deploy/configure/secure/monitor

Optimize the document directory structure

484b037

lilin90 requested a review from YiniXu9506 April 25, 2019 09:13

lilin90 changed the title ~~Optimize the document directory structure~~ toc: optimize the document directory structure Apr 25, 2019

lilin90 reviewed Apr 25, 2019

View reviewed changes

lilin90 requested review from dcalvin and QueenyJin April 25, 2019 09:25

QueenyJin approved these changes Apr 25, 2019

View reviewed changes

toc: remove unnecessary blank lines

01097fc

lilin90 reviewed Apr 26, 2019

View reviewed changes

lilin90 added 2 commits April 26, 2019 10:52

toc: update format and fix spaces

9b6cd54

toc: update DM overview based on DBA feedback

fc9f59a

lilin90 mentioned this pull request Apr 26, 2019

toc: update DM, SQL, contribute #1268

Closed

dcalvin reviewed Apr 26, 2019

View reviewed changes

lilin90 added the type/refactor The issue belongs to a refactor work. label Apr 28, 2019

toc: update DM deployment

9f458ba

morgo mentioned this pull request May 8, 2019

Update remaining how-to pages to use new URL structure pingcap/docs#1111

Merged

Merge branch 'master' into adjust_dir

77ed9a7

lilin90 added a commit to lilin90/docs-cn that referenced this pull request May 13, 2019

toc, support: reorganize TOC and update a link

56faff0

Related PR: pingcap#1279

lilin90 mentioned this pull request May 13, 2019

toc, support: reorganize TOC and update a link #1320

Merged

lilin90 added a commit that referenced this pull request May 13, 2019

toc, support: reorganize TOC and update a link (#1320)

2e7b2b8

* toc, support: reorganize TOC and update a link Related PR: #1279 * toc: udpate description * toc: update wording

lilin90 closed this May 13, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

toc: optimize the document directory structure #1279

toc: optimize the document directory structure #1279

scsldb commented Apr 25, 2019

CLAassistant commented Apr 25, 2019 •

edited

Loading

lilin90 Apr 25, 2019

YiniXu9506 Apr 25, 2019

QueenyJin commented Apr 25, 2019

lilin90 Apr 26, 2019 •

edited

Loading

scsldb May 6, 2019

lilin90 May 6, 2019

lilin90 Apr 26, 2019 •

edited

Loading

scsldb May 6, 2019

lilin90 May 6, 2019 •

edited

Loading

scsldb May 6, 2019

dcalvin Apr 26, 2019

morgo commented May 8, 2019

lilin90 commented May 13, 2019

toc: optimize the document directory structure #1279

toc: optimize the document directory structure #1279

Conversation

scsldb commented Apr 25, 2019

CLAassistant commented Apr 25, 2019 • edited Loading

lilin90 Apr 25, 2019

Choose a reason for hiding this comment

YiniXu9506 Apr 25, 2019

Choose a reason for hiding this comment

QueenyJin commented Apr 25, 2019

lilin90 Apr 26, 2019 • edited Loading

Choose a reason for hiding this comment

scsldb May 6, 2019

Choose a reason for hiding this comment

lilin90 May 6, 2019

Choose a reason for hiding this comment

lilin90 Apr 26, 2019 • edited Loading

Choose a reason for hiding this comment

scsldb May 6, 2019

Choose a reason for hiding this comment

lilin90 May 6, 2019 • edited Loading

Choose a reason for hiding this comment

scsldb May 6, 2019

Choose a reason for hiding this comment

dcalvin Apr 26, 2019

Choose a reason for hiding this comment

morgo commented May 8, 2019

lilin90 commented May 13, 2019

CLAassistant commented Apr 25, 2019 •

edited

Loading

lilin90 Apr 26, 2019 •

edited

Loading

lilin90 Apr 26, 2019 •

edited

Loading

lilin90 May 6, 2019 •

edited

Loading