Doc 12461 auto compaction page clarifications #4045
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
* Removed some unneeded screenshots. * Brought some of the writing up to doc standards.
…nd Couchstore settings.
There was a problem hiding this comment.
Pull request overview
This PR addresses DOC-12461 by updating the auto-compaction documentation to improve clarity and accuracy. The changes modernize the content to reflect current product behavior and documentation standards.
- Clarifies that Time Interval settings are specific to Couchstore buckets and not available for Magma buckets
- Updates outdated screenshots to reflect current UI
- Improves writing style throughout to align with documentation standards
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,5 +1,5 @@ | |||
| = Auto-Compaction | |||
| :description: pass:q[Auto-Compaction settings determine the _compaction process_; whereby databases and their respective view-indexes are compacted.] | |||
| :description: pass:The auto-Compaction settings controls if and when Couchbase Server compacts data files and view indexes.] | |||
There was a problem hiding this comment.
Subject-verb agreement error: 'settings' is plural but 'controls' is singular. Should be 'control' to match the plural subject.
Suggested change
| :description: pass:The auto-Compaction settings controls if and when Couchbase Server compacts data files and view indexes.] | |
| :description: pass:The auto-Compaction settings control if and when Couchbase Server compacts data files and view indexes.] |
| Auto-Compaction is enabled by default for all Couchbase buckets. | ||
| However, settings can be overridden on a per bucket basis. | ||
| Auto-compaction reclaims disk space by removing stale and deleted data from on-disk storage files. | ||
| By default, Couchbase Server performs auto-compaction all Couchbase buckets. |
There was a problem hiding this comment.
Missing preposition 'on' between 'auto-compaction' and 'all'. Should read 'performs auto-compaction on all Couchbase buckets'.
Suggested change
| By default, Couchbase Server performs auto-compaction all Couchbase buckets. | |
| By default, Couchbase Server performs auto-compaction on all Couchbase buckets. |
| ==== Time Interval | ||
|
|
||
| The [.ui]*Time Interval* pane provides a number of settings whereby compaction is scheduled: | ||
| The *Time Interval* section lets you limit he hours where Couchbase Server can compact Couchstore buckets. |
There was a problem hiding this comment.
Typo: 'he hours' should be 'the hours'.
Suggested change
| The *Time Interval* section lets you limit he hours where Couchbase Server can compact Couchstore buckets. | |
| The *Time Interval* section lets you limit the hours where Couchbase Server can compact Couchstore buckets. |
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.
Mainly adressing DOC-12461:
Preview URL:
https://preview.docs-test.couchbase.com/docs-server-DOC-12461_Auto-Compaction_page_clarifications/server/current/manage/manage-settings/configure-compact-settings.html
You will need the Docs Team credentials on Confluence.