Convert English Docs to DITA ToC #996

morgo · 2019-03-29T17:16:53Z

This PR converts the ToC to a DITA structure. None of the files have been moved (we should do that later, and ensure redirects to retain SEO).

morgo · 2019-03-29T17:43:47Z

@queenypingcap @lilin90 @CaitinChen @dcalvin PTAL

The quickstart has not been written yet, and the link to optimizer hints requires #997 to merge. The other file splits have been completed.

TOC.md

morgo · 2019-04-08T02:44:55Z

@queenypingcap @lilin90 @CaitinChen @dcalvin This PR is now ready for your review. Thanks!

dcalvin

See my comments in line.

TOC.md

Co-Authored-By: morgo <[email protected]>

TOC.md

Co-Authored-By: morgo <[email protected]>

TOC.md

morgo · 2019-04-10T02:31:09Z

This is a shell script to compare between master and this branch (sorting and uniq'ing to account for structure differences):

filter(){ perl -ne '/\((.*?)[#)]/ and print "$1\n"' | sort | uniq; }; vimdiff <(filter < TOC.md) <(git show master:TOC.md | filter)

The pages in master that are not in this branch:

- community.md (we have contribute.md and support.md, which kind of fills a similar role)
- https://github.com/tikv/tikv/wiki
- https://pingcap.com/blog/
- https://pingcap.com/weekly/
- op-guide/tidb-config-file.md (redundant; there is another config topic)
- op-guide/tidb-v2.0-upgrade-guide.md (out of date: covers upgrading to 2.0)
- sql/server-command-option.md (redundant; there is another config topic)
- sql/tidb-server.md (redundant/not that helpful)

kolbe

LGTM

...

kolbe

LGTM

ceohockey60 · 2019-04-10T04:33:35Z

LGTM

TOC.md

dcalvin

Further comments

TOC.md

Co-Authored-By: morgo <[email protected]>

TOC.md

Co-Authored-By: morgo <[email protected]>

lilin90

LGTM

* Convert English Docs to DITA ToC (#996) The content remains the same. Only the TOC changes in this PR * Fix a broken link (#1047) * tools: add more argument description of Syncer (#1030) * tools: add more argument description of syncer Via: pingcap/docs-cn#1215 * sql: add working mechanism of system variables (#1035) Via: pingcap/docs-cn#1225 PTAL * overview, intro: move content around (#1045) * Update TOC.md * Update and rename overview.md to key-features.md * Update and rename QUICKSTART.md to overview.md * TOC: fix breakage from #1045 (#1050) The features linked to overview.md * Sql/transaction: changes on variables (#1036) * tools, v2.1: fix a typo (#1052) * add blank line and fix incorrect link (#1051) * toc, config flags: fix inconsistencies in headings (#1054) * fix inconsistencies in file names and heading * use 2nd level heading for all flags * fix typo in meta * revert file name change until later * revert file name * escape * character * sql: update EXPLAIN related document (#1039) * fix the format error * Revert "fix the format error" This reverts commit 2855bbd. * sysbench-v4: fix a format error * sql: add and modify some contents * Revert "sysbench-v4: fix a format error" This reverts commit 2d9016c. * sql: update sql\EXPLAIN related documents * Update mysql-compatibility.md * correct one format error * Add homebrew and dbdeployer guides (#1056) * Add homebrew and dbdeployer guides * fix case * Update install-from-homebrew.md * Fix tabs

* Convert English Docs to DITA ToC (#996) The content remains the same. Only the TOC changes in this PR * Changed URL structure of how-to/get-started. Fixed s/sample/example/ bug introduced in DITA * fixed categories * Fixed bugs * Fix a broken link (#1047) * tools: add more argument description of Syncer (#1030) * tools: add more argument description of syncer Via: pingcap/docs-cn#1215 * sql: add working mechanism of system variables (#1035) Via: pingcap/docs-cn#1225 PTAL * Fix broken link * fix broken link * fix broken links * fix broken links * overview, intro: move content around (#1045) * Update TOC.md * Update and rename overview.md to key-features.md * Update and rename QUICKSTART.md to overview.md * TOC: fix breakage from #1045 (#1050) The features linked to overview.md * Sql/transaction: changes on variables (#1036) * tools, v2.1: fix a typo (#1052) * add blank line and fix incorrect link (#1051) * toc, config flags: fix inconsistencies in headings (#1054) * fix inconsistencies in file names and heading * use 2nd level heading for all flags * fix typo in meta * revert file name change until later * revert file name * escape * character * sql: update EXPLAIN related document (#1039) * fix the format error * Revert "fix the format error" This reverts commit 2855bbd. * sysbench-v4: fix a format error * sql: add and modify some contents * Revert "sysbench-v4: fix a format error" This reverts commit 2d9016c. * sql: update sql\EXPLAIN related documents * Update mysql-compatibility.md * correct one format error * Add homebrew and dbdeployer guides (#1056) * Add homebrew and dbdeployer guides * fix case * Update install-from-homebrew.md * fix tabs (#1058) Unfortunately I can't preview this, because the preview website has not updated in >2 hours. * benchmark: update wording (#1055) * benchmark: update wording * Remove "the" * Minor typo fix (#1061) * gsod: add TiDB project ideas (#1066) * gsod: add TiDB project ideas * gsod: update the file name and format * Small change to bash scripting for downloading bikeshare data files (#1063) Use curl instead of wget (more commonly available) * Fix formatting * Attempt to fix broken link

* Convert English Docs to DITA ToC (#996) The content remains the same. Only the TOC changes in this PR * Fix a broken link (#1047) * tools: add more argument description of Syncer (#1030) * tools: add more argument description of syncer Via: pingcap/docs-cn#1215 * sql: add working mechanism of system variables (#1035) Via: pingcap/docs-cn#1225 PTAL * overview, intro: move content around (#1045) * Update TOC.md * Update and rename overview.md to key-features.md * Update and rename QUICKSTART.md to overview.md * Initial move of monitor/secure * TOC: fix breakage from #1045 (#1050) The features linked to overview.md * Sql/transaction: changes on variables (#1036) * tools, v2.1: fix a typo (#1052) * add blank line and fix incorrect link (#1051) * toc, config flags: fix inconsistencies in headings (#1054) * fix inconsistencies in file names and heading * use 2nd level heading for all flags * fix typo in meta * revert file name change until later * revert file name * escape * character * sql: update EXPLAIN related document (#1039) * fix the format error * Revert "fix the format error" This reverts commit 2855bbd. * sysbench-v4: fix a format error * sql: add and modify some contents * Revert "sysbench-v4: fix a format error" This reverts commit 2d9016c. * sql: update sql\EXPLAIN related documents * Update mysql-compatibility.md * correct one format error * Add homebrew and dbdeployer guides (#1056) * Add homebrew and dbdeployer guides * fix case * Update install-from-homebrew.md * fix tabs (#1058) Unfortunately I can't preview this, because the preview website has not updated in >2 hours. * benchmark: update wording (#1055) * benchmark: update wording * Remove "the" * Minor typo fix (#1061) * gsod: add TiDB project ideas (#1066) * gsod: add TiDB project ideas * gsod: update the file name and format * Small change to bash scripting for downloading bikeshare data files (#1063) Use curl instead of wget (more commonly available) * Change URL structure of how-to/get-started (#1046) Changed URL structure of how-to/get-started. Fixed s/sample/example/ bug introduced in DITA fixed categories * Attempt to fix relative link. (#1069) There seems to be a problem with the website in that the filename in the current directory is not relative. I am not sure if this will fix it, but I have to try, since including the full path (/dev/how-to/..) makes version split more difficult, since only one version will be /dev/. * tools, media: update binlog's config file (#1053) * tools, media: update binlog's config file * Update tools/tidb-binlog-cluster.md Co-Authored-By: IzabelWang <[email protected]> * Update tools/tidb-binlog-cluster.md Co-Authored-By: IzabelWang <[email protected]> * Update tools/tidb-binlog-cluster.md Co-Authored-By: IzabelWang <[email protected]> * Update tools/tidb-binlog-cluster.md Co-Authored-By: IzabelWang <[email protected]> * Update tools/tidb-binlog-cluster.md Co-Authored-By: IzabelWang <[email protected]> * Update tidb-binlog-cluster.md Add ”txn-batch = 20". * Update tidb-binlog-cluster.md Address a commit. * Update tidb-binlog-cluster.md Address a commit. * v2.1/tools: update TiDB-Binlog * Revert "v2.1/tools: update TiDB-Binlog" This reverts commit 60e49a5. * Update tools/tidb-binlog-cluster.md Co-Authored-By: IzabelWang <[email protected]> * v2.1/tools: update TiDB-Binlog (#1059) * v2.1/tools: update TiDB-Binlog * Update tidb-binlog-cluster.md Address a commit. * op-guide: update TiDB-Ansible version information (#1064) * Fix broken link using absolute reference (#1077) * Cleaned up and added TiDB Server info (#1076) * Cleaned up and added TiDB Server info * More doc cleanup * Fixed table of node mappings * Clarified command line parameters * Fixed letter casing and indenting * Clarified need to download binlogctl * update condition (#1072) * benchmark, v2.1/benchmark: remove an invalid link (#1080) * *: update the Note format (#1079) * *: update the Note format * Update note format * Update the Note format * ROADMAP: add supporting invisible index (#1070) * ROADMAP: add supporting invisible index 1. Add supporting invisible index 2. Fix a spelling mistake in line 45 * ROADMAP: add supporting invisible index * Update ROADMAP.md Co-Authored-By: IzabelWang <[email protected]> * sql, TOC: update doc title (#1071) * Update URLs for deploy (#1048) * Moved how-to/deply files to new URLs * Update URLs to use absolute links. * Update the rest of how-to files * fix missing toc updates * Fix missing file rename * sql: update the USE command explanation in util document (#1075) * docs-cn #1112 Update the USE command explanation in util document * Update sql/util.md Co-Authored-By: ericsyh <[email protected]> * Update v1.0/sql/util.md Co-Authored-By: ericsyh <[email protected]> * Update v2.0/sql/util.md Co-Authored-By: ericsyh <[email protected]> * Update v2.1/sql/util.md Co-Authored-By: ericsyh <[email protected]> * update the loader pprof-addr default port (#1065) * releases: correct the TiDB-Ansible version (#1084) * *: update the Warning format (#1082) * TOC: fix a broken link and update capitalization (#1090) * *: explain select for update statement (#1093) * *: explain select for update statement Via: pingcap/docs-cn#1284 * *: update wording * *: update description * *: update format and wording * tools: update syncer batch size (#1092) * trouble-shooting: update the issue report link (#1091) * 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]>

morgo added 2 commits March 29, 2019 11:15

DITA ToC Proof of concept

5f29678

Add optimizer hints

1c8f3ec

kennytm reviewed Mar 30, 2019

View reviewed changes

TOC.md Outdated Show resolved Hide resolved

Address Feedback, Fix Lightning Name

933da1f

morgo changed the title ~~DITA ToC Proof of concept~~ Convert English Docs to DITA ToC Apr 8, 2019

morgo marked this pull request as ready for review April 8, 2019 02:40

morgo requested review from QueenyJin, lilin90, dcalvin and CaitinChen April 8, 2019 02:40

Merge branch 'master' into morgo-dita

0c982a3

dcalvin reviewed Apr 8, 2019

View reviewed changes

TOC.md Outdated Show resolved Hide resolved

TOC.md Outdated Show resolved Hide resolved

TOC.md Outdated Show resolved Hide resolved

TOC.md Outdated Show resolved Hide resolved

dcalvin and others added 6 commits April 7, 2019 23:57

Update TOC.md

06d2c31

Co-Authored-By: morgo <[email protected]>

Update TOC.md

ded433a

Co-Authored-By: morgo <[email protected]>

Update TOC.md

8746b6a

Co-Authored-By: morgo <[email protected]>

Update TOC.md

e3605dd

Update TOC.md

590078c

Update TOC.md

0b7b9fc

dcalvin reviewed Apr 8, 2019

View reviewed changes

TOC.md Outdated Show resolved Hide resolved

morgo and others added 6 commits April 8, 2019 10:58

Update TOC.md

85fdfa6

Merge branch 'master' into morgo-dita

74528be

Update TOC.md

098fefa

Co-Authored-By: morgo <[email protected]>

Merge branch 'master' into morgo-dita

8dff337

Update TOC.md

ebfe6c2

Restore previous change

1771150

lilin90 requested review from shenli and dbaoutdo April 9, 2019 07:52

lilin90 reviewed Apr 9, 2019

View reviewed changes

TOC.md Outdated Show resolved Hide resolved

TOC.md Outdated Show resolved Hide resolved

TOC.md Outdated Show resolved Hide resolved

TOC.md Outdated Show resolved Hide resolved

morgo added 2 commits April 9, 2019 17:10

Add missing links.

56bd845

Update TOC.md

e30c094

kolbe previously approved these changes Apr 10, 2019

View reviewed changes

kolbe reviewed Apr 10, 2019

View reviewed changes

Merge branch 'master' into morgo-dita

844717c

dcalvin reviewed Apr 11, 2019

View reviewed changes

TOC.md Outdated Show resolved Hide resolved

dcalvin reviewed Apr 11, 2019

View reviewed changes

TOC.md Show resolved Hide resolved

dcalvin reviewed Apr 11, 2019

View reviewed changes

TOC.md Show resolved Hide resolved

TOC.md Show resolved Hide resolved

dcalvin and others added 5 commits April 11, 2019 08:32

Update TOC.md

fa939fb

Co-Authored-By: morgo <[email protected]>

Address calvins feedback

54adecc

Merge branch 'morgo-dita' of github.com:pingcap/docs into morgo-dita

60f54b7

Merge branch 'master' into morgo-dita

829b635

Update TOC.md

49a5d35

lilin90 reviewed Apr 12, 2019

View reviewed changes

TOC.md Outdated Show resolved Hide resolved

TOC.md Outdated Show resolved Hide resolved

TOC.md Outdated Show resolved Hide resolved

lilin90 and others added 5 commits April 12, 2019 10:19

Update TOC.md

36ea2e5

Co-Authored-By: morgo <[email protected]>

Update TOC.md

9ce670d

Co-Authored-By: morgo <[email protected]>

Update TOC.md

659c0c8

Co-Authored-By: morgo <[email protected]>

Add 2.1 release notes

cdc3a52

Merge branch 'master' into morgo-dita

bead455

lilin90 approved these changes Apr 14, 2019

View reviewed changes

morgo merged commit 3a42206 into master Apr 14, 2019

morgo deleted the morgo-dita branch April 14, 2019 02:32

lilin90 mentioned this pull request Apr 16, 2019

TOC: covert docs-cn to DITA TOC pingcap/docs-cn#1242

Merged

sre-bot added the contribution This PR is from a community contributor. label Dec 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert English Docs to DITA ToC #996

Convert English Docs to DITA ToC #996

morgo commented Mar 29, 2019

morgo commented Mar 29, 2019

morgo commented Apr 8, 2019

dcalvin left a comment

morgo commented Apr 10, 2019

kolbe left a comment

kolbe left a comment

ceohockey60 commented Apr 10, 2019

dcalvin left a comment

lilin90 left a comment

Convert English Docs to DITA ToC #996

Convert English Docs to DITA ToC #996

Conversation

morgo commented Mar 29, 2019

morgo commented Mar 29, 2019

morgo commented Apr 8, 2019

dcalvin left a comment

Choose a reason for hiding this comment

morgo commented Apr 10, 2019

kolbe left a comment

Choose a reason for hiding this comment

kolbe left a comment

Choose a reason for hiding this comment

ceohockey60 commented Apr 10, 2019

dcalvin left a comment

Choose a reason for hiding this comment

lilin90 left a comment

Choose a reason for hiding this comment