docs/*: add overview, op-guide, client #3494
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: lilin90 <lilin@pingcap.com>
|
@queenypingcap PTAL |
|
overview may be duplicated with readme? |
|
@siddontang I also noticed that when I commit. I keep it because later we'll maintain a whole set of separate documentation for TiKV and might put them on a separate website page. And all those contents come from here (tikv/docs). Currently, I'll maintain TiKV documentation at TiKV Wiki. |
QueenyJin
previously approved these changes
Aug 22, 2018
siddontang
previously approved these changes
Aug 22, 2018
|
PTAL @Hoverbear |
Hoverbear
reviewed
Aug 23, 2018
docs/clients/go-client-api.md
Outdated
|
|
||
| ## Try the Raw Key-Value API | ||
|
|
||
| To use the Raw Key-Value API in applications developed by golang, take the following steps: |
Hoverbear
reviewed
Aug 23, 2018
docs/clients/go-client-api.md
Outdated
| Description of two parameters in the above command: | ||
|
|
||
| - `string`: a list of PD servers’ addresses | ||
| - `config.Security`: used for establishing TLS connections, usually left empty when you do not need TLS |
There was a problem hiding this comment.
Is it expected that the user will understand how to set up TLS here if they want it?
Hoverbear
reviewed
Aug 23, 2018
docs/clients/go-client-api.md
Outdated
|
|
||
| - Transaction | ||
|
|
||
| Like the Transaction in SQL, a Transaction symbolizes a series of read and write operations performed within the Storage. Internally, a Transaction consists of a Snapshot for reads, and a MemBuffer for all writes. The default isolation level of a Transaction is Snapshot Isolation. |
There was a problem hiding this comment.
Like transactions in SQL
Hoverbear
reviewed
Aug 23, 2018
| - CentOS 7.3 (64 bit) or later with Python 2.7 installed, x86_64 architecture (AMD64) | ||
| - Network between machines | ||
|
|
||
| > **Note:** When you deploy TiKV using Ansible, use SSD disks for the data directory of TiKV and PD nodes. Otherwise, it cannot pass the check. For more details, see [Software and Hardware Requirements](https://github.com/pingcap/docs/blob/master/op-guide/recommendation.md). |
There was a problem hiding this comment.
I think we can have a better reason than this. Maybe "Otherwise, the system will not perform well."
Signed-off-by: lilin90 <lilin@pingcap.com>
lilin90
dismissed stale reviews from zhangjinpeng87, siddontang, and QueenyJin
via
0a17da0
|
@siddontang @zhangjinpeng1987 @Hoverbear PTAL again. Thanks! |
zhangjinpeng87
approved these changes
Aug 28, 2018
siddontang
approved these changes
Aug 29, 2018
sticnarf
pushed a commit
to sticnarf/tikv
that referenced
this pull request
Oct 27, 2019
* docs/*: add overview, op-guide, client Signed-off-by: lilin90 <lilin@pingcap.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: lilin90 lilin@pingcap.com
What have you changed? (mandatory)
Add the following TiKV documents:
Does this PR affect documentation (docs/docs-cn) update? (mandatory)
Relevant.
Does this PR affect tidb-ansible update? (mandatory)
No.