Split the readme into multiple files#313
Merged
dkasimovskiy merged 1 commit intomasterfrom Nov 30, 2022
Merged
Conversation
5a8eae3 to
0320f3e
Compare
akudiyar
requested changes
Nov 28, 2022
|
|
||
| All this properties should be used carefully, because if threads more than need may give low app performance | ||
| ## Advanced usage | ||
| [Cluster Tarantool client](doc/ClusterTarantoolClient.md) |
Collaborator
There was a problem hiding this comment.
I suggest adding a short description in a single paragraph for each page with some keywords that the user will be looking for, like "transient cluster failures" for the "retrying client" section. Also, I suggest renaming these documents to better reflect the use cases, having in mind that the users shouldn't use the TarantoolClient classes directly.
Contributor
Author
There was a problem hiding this comment.
If you have any ideas for a different name for the cluster and proxy clent I would be happy to see your suggestions
0320f3e to
8de1974
Compare
bitgorbovsky
previously approved these changes
Nov 29, 2022
ArtDu
requested changes
Nov 29, 2022
| @@ -0,0 +1,89 @@ | |||
| [Main page](../README.md) | |||
Contributor
There was a problem hiding this comment.
Move it to docs directory. It's strange to have two similar directories
Contributor
Author
There was a problem hiding this comment.
Didn't notice it, will be fixed
Comment on lines
+50
to
+61
| [Cluster client](doc/ClusterTarantoolClient.md) | ||
| Connecting to Cartridge router nodes | ||
| [Proxy client](doc/ProxyTarantoolClient.md) | ||
| Connecting to any Tarantool nodes, calling stored functions | ||
| [Custom sharding function](doc/CustomShardingFunction.md) | ||
| Determining bucket id in on the client side | ||
| [Retrying client](doc/RetryingTarantoolClient.md) | ||
| Circumventing transient cluster failures | ||
| [TarantoolTuple usage](doc/TarantoolTupleUsage.md) | ||
| Creating and operating with TarantoolTuple | ||
| [Thread control](doc/ThreadControl.md) | ||
| Specifying custom numbers of netty work threads |
Contributor
There was a problem hiding this comment.
I want to suggest something like that
Suggested change
| [Cluster client](doc/ClusterTarantoolClient.md) | |
| Connecting to Cartridge router nodes | |
| [Proxy client](doc/ProxyTarantoolClient.md) | |
| Connecting to any Tarantool nodes, calling stored functions | |
| [Custom sharding function](doc/CustomShardingFunction.md) | |
| Determining bucket id in on the client side | |
| [Retrying client](doc/RetryingTarantoolClient.md) | |
| Circumventing transient cluster failures | |
| [TarantoolTuple usage](doc/TarantoolTupleUsage.md) | |
| Creating and operating with TarantoolTuple | |
| [Thread control](doc/ThreadControl.md) | |
| Specifying custom numbers of netty work threads | |
| * [Cluster client](doc/ClusterTarantoolClient.md) | |
| Connecting to Tarantool nodes. | |
| The client can connect to storages and obtain data from spaces directly by space interface via native iproto binary protocol. | |
| It may call lua storing procedures or eval lua code on nodes. | |
| * [Proxy methods](doc/ProxyTarantoolClient.md) | |
| Connecting to routers with crud library. It proxies space interface's methods to crud methods. | |
| * [Retrying](doc/RetryingTarantoolClient.md) | |
| Retry transient cluster failures. | |
| * [TarantoolTuple usage](doc/TarantoolTupleUsage.md) | |
| Creating and operating with TarantoolTuple entity. | |
| * [Custom sharding function](doc/CustomShardingFunction.md) | |
| Determining bucket id on java side. | |
| * [Thread control](doc/ThreadControl.md) | |
| Specifying custom numbers of netty work threads. |
bitgorbovsky
previously approved these changes
Nov 29, 2022
ArtDu
requested changes
Nov 29, 2022
| https://github.com/tarantool/cartridge-java/blob/2f8e826deb9833a5deb6d21177527a46e8fdd039/src/test/java/io/tarantool/driver/integration/SingleInstanceExampleTest.java#L64-L79 | ||
|
|
||
| You can read more about Cartridge applications in its [documentation](https://www.tarantool.io/ru/doc/latest/how-to/getting_started_cartridge/). | ||
| You can read more about Cartridge applications in its [documentation](https://www.tarantool.io/ru/docs/latest/how-to/getting_started_cartridge/). |
b4fcae5 to
f666711
Compare
f666711 to
e430804
Compare
The information for more advanced users should be extracted from the README and broken down into files Closes #312
e430804 to
bd61b99
Compare
ArtDu
approved these changes
Nov 29, 2022
bitgorbovsky
approved these changes
Nov 29, 2022
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
The information for more advanced users should be extracted from the README and broken down into files
I haven't forgotten about:
Related issues:
Closes #312