Add documentation about options used in database creation #243
Conversation
There was a problem hiding this comment.
I think it would help to add a further description to the "sharding" attribute. What does "single" actually mean? Additionally, it is probably not intuitively clear what the "minimum replication factor" is without further description.
If you could add an explanatory sentence to these options it would be cool. Thanks!
| The *options* attribute can be used to set defaults for collections that will | ||
| be created in the new database: | ||
|
|
||
| * *sharding*: The sharding method to use. Valid values are: "" or "single |
There was a problem hiding this comment.
| * *sharding*: The sharding method to use. Valid values are: "" or "single | |
| * *sharding*: The sharding method to use. Valid values are: "" or "single". |
|
The descriptions of options should really be in a single place. Is there some plan to remove the split of the documentation? |
|
I agree. @Simran-B : are there any changes planned for cleaning up the documentation "mess", i.e. removing the need to adjust two repositories when docs are adjusted? |
| * *replicationFactor*: Default replication factor. Special values include "satellite", | ||
| which will replicate the collection to every DB-server, and 1, which disables replication. | ||
| * *minReplicationFactor*: Default minimum replication factor. | ||
| * *minReplicationFactor*: Default minimum replication factor. Collections with | ||
| a lower replication factor than this value can not be created in the new |
There was a problem hiding this comment.
This is actually not what this attribute is doing.
Can you check other occurrences of "minReplicationFactor" in the docs or changelog or new features to see what it does exactly?
@jsteemann Do you refer to the DocuBlock being in the main repo and the rest being here? Well, I discussed this with Jörg last week and we do want to put everything into the docs repo. This isn't an easy task however, and we may do additional refactoring as part of a larger project soon. |
No description provided.