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

overview, intro: move content around #1045

Merged
merged 7 commits into from
Apr 15, 2019
Merged

overview, intro: move content around #1045

merged 7 commits into from
Apr 15, 2019

Conversation

morgo
Copy link
Contributor

@morgo morgo commented Apr 14, 2019

This PR moves the key-features introduction under concepts/key-features. The index page becomes what was QUICKSTART (for now).

The plan is to change QUICKSTART to be a proper quickstart, with an overview of each of the key sections of the manual. We will work with the designers to make this possible.

It is important to merge this intermediate version because of an inconsistency:
If you visit pingcap.com/docs you will land on key-features, but if you click on the 'introduction' heading again you will get Quickstart.

@lilin90 lilin90 requested review from dcalvin and QueenyJin April 15, 2019 06:21
overview.md Outdated Show resolved Hide resolved
key-features.md Outdated Show resolved Hide resolved
@ceohockey60
Copy link
Contributor

LGTM


TiDB is designed to support both transaction processing (OLTP) and analytical processing (OLAP) workloads. This means that while you may have traditionally transacted on MySQL and then Extracted, Transformed and Loaded (ETL) data into a column store for analytical processing, this step is no longer required.

With trends in business such as moving from two-day delivery to instant, it is important to be able to run analytics with minimal delay. The future is in HTAP databases which can perform the _hybrid_ of Transactional and Analytical processing.

Choose a reason for hiding this comment

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

👍 👏

@morgo morgo merged commit bfab780 into pingcap:master Apr 15, 2019
@morgo morgo deleted the fix-intro branch April 15, 2019 18:07
morgo added a commit that referenced this pull request Apr 16, 2019
The features linked to overview.md
morgo added a commit that referenced this pull request Apr 17, 2019
* 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
lilin90 added a commit to lilin90/docs-cn that referenced this pull request Apr 18, 2019
lilin90 added a commit to pingcap/docs-cn that referenced this pull request Apr 18, 2019
lilin90 added a commit to pingcap/docs-cn that referenced this pull request Apr 18, 2019
* v2.1/tools, v2.1/tools: update TiDB-Binlog (#1245)

v2.1/tools: update TiDB-Binlog

* *: move overview and features (#1253)

Via: pingcap/docs#1045

* toc: update toc with refined overview
morgo added a commit that referenced this pull request Apr 20, 2019
* 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
morgo added a commit that referenced this pull request Apr 29, 2019
* 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]>
lilin90 added a commit to pingcap/docs-cn that referenced this pull request May 13, 2019
* 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
lilin90 added a commit to pingcap/docs-cn that referenced this pull request May 13, 2019
* toc: reorganize docs-cn to DITA TOC

* toc: update DITA TOC

* toc: update toc with refined overview and features (#1254)

* v2.1/tools, v2.1/tools: update TiDB-Binlog (#1245)

v2.1/tools: update TiDB-Binlog

* *: move overview and features (#1253)

Via: pingcap/docs#1045

* toc: update toc with refined overview

* *: rename how-to deploy/configure/secure/monitor
@sre-bot sre-bot added the contribution This PR is from a community contributor. label Dec 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution This PR is from a community contributor.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants