DOC-13223 sizing guidelines, note on residentRatio #347
Conversation
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
|
Here's what the bot has to say: So that's a 50% success... 🤦 |
osfameron
approved these changes
May 16, 2025
|
Recommend editing the PR name to something like "DOC-13223 sizing guidelines, note on residentRatio" |
rao-shwe
requested changes
May 16, 2025
There was a problem hiding this comment.
Change to:
NOTE: Couchbase recommends setting the residentRatio property value over 10 to avoid issues, for example, index build failures.
- Instead of "we", the generic technical writing guidelines suggest to use the company's brand name.
- residentRatio is an object property, so it is better to use the complete nomenclature, which is "residentRatio property".
- "over" goes well with conversational style of writing.
- "10" is a value, so it would be better to define what "10" represents.
- "like" becomes quite a casual word for a NOTE. Also, it would mean that we are directing the user's attention to "index build failures". But "for example" eases the information about the failure.
TimLFletcher
changed the title
sarahlwelton
pushed a commit
that referenced
this pull request
May 27, 2025
sarahlwelton
pushed a commit
that referenced
this pull request
May 27, 2025
simon-dew
pushed a commit
that referenced
this pull request
Sep 9, 2025
simon-dew
pushed a commit
that referenced
this pull request
Sep 11, 2025
sarahlwelton
pushed a commit
that referenced
this pull request
Sep 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Added a note to signal that low residentRatio values can lead to issues with indexing.
Linked to the server docs change here that gives guardrails info:
couchbase/docs-server#3808