tarantool / tarantool/doc

[2pt] Minor things in the repl_sync file

Open
#2,121 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

rewrite server
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Proofread repl_sync

Info

Root document: https://www.tarantool.io/en/doc/latest/book/replication/repl_sync/

What's wrong?

Some things could be phrased differently.
"it does not mean" could be "that does not mean"
"responds success" could be "responds successfully"
"are not responded to a client" could be "the client does not get a response"
"there exist global" could be "there are global"
"accounts all replicas, including anonymous" could be "counts all replicas including anonymous ones"
"makes replace()" could be "does a replace()"
"its receipt and successful appliance" could be "that it received and successfully applied"
"in the given time" could be "within the timeout period"
"The rollbacks are similarly persisted" could be "Rollbacks are similarly persisted
"It means if the master dies" could be "That means that, if the master dies,"
"A killer feature" could be "A significant feature"
"it will also be blocked" could be "it too will be blocked"
"behavior is very similar to a regular queue" could be "behavior is very similar to behavior of a regular queue"
"So, here comes the commit rule" could be "So here is the commit rule"
"regardless of being synchronous or asynchronous" could be "regardless whether they are synchronous or asynchronous"
"it will first roll back all the newer pending transactions" could be "all new pending transactions will be rolled back"
"Again, just like how" could be "Again, this is like the way that"
"when WAL write fails" could be "when a WAL write fails"
"So, here comes the rollback rule" could be "So here is the rollback rule"
"the order reversed from the commit start order" could be "the reverse of the commit-start order"
"regardless of being synchronous or asynchronous" could be "regardless whether they are synchronous or asynchronous"
"has the built-in functionality managing" could be "has built-in functionality to manage"
"refer to the corresponding chapter" could be "refer to the chapter on leader election"
"Synchronous transactions are better to use with full mesh" could be "It is better to use synchronous transactions with full mesh"

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the root document at https://www.tarantool.io/en/doc/latest/book/replication/repl_sync/ and review the listed phrases in context. Apply the proposed wording changes throughout the repl_sync documentation, then proofread the page to confirm every reported phrasing issue has been addressed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.