Details
-
Bug
-
Resolution: Won't Fix
-
Major
-
None
-
4.5
Description
Email feedback from Perry Krug
I came across a need to reference compaction and noticed a few things amiss with this page: http://developer.couchbase.com/documentation/server/4.5/rest-api/compaction-rest-api.html
- In the first paragraph, it mentions that the compaction process can lead to gaps in the disk file which is not quite right. In fact the use of an "append-only storage format" is what leads to stale information (not gaps) and the compaction process is what removes that stale information to reclaim disk space.
- The first table of compaction endpoints is incomplete (doesn't include regular views) and is also somewhat unclear as to why these particular endpoints are here in this place.
- Along the lines with this table, isn't a bucket role able to be used to compact an individual bucket? This table seems to imply that only Full and Cluster roles are able to perform compaction. The next table below seems to have Bucket roles included.
- I believe the "purge interval" is incorrect. Originally we did allow only 1-60 days, but then we allowed it to be set as low as 0.4 (which equals 1 hour)
- There is no sub section for compacting regular views
- I think this sub-section is in the wrong place: http://developer.couchbase.com/documentation/server/4.5/rest-api/security-encrypted-access.html
- The formatting of the first line of these sub sections could use some cleanup: http://developer.couchbase.com/documentation/server/4.5/rest-api/rest-compact-post.html and http://developer.couchbase.com/documentation/server/4.5/rest-api/rest-compact-spatialviews.html
- There is a sub-section for "getting" the compaction settings, but why not a sub-section for changing them? http://developer.couchbase.com/documentation/server/4.5/rest-api/rest-autocompact-get.html
- At a bit of a higher level, this page is a great example of where cross-linking would help a lot. IMO, we really need a section on the page of "related information" that can be shown across all of the compaction-related pages, the section at the bottom is too specific to the hierarchy and also not very visible unless you scroll all the way to the bottom.
- Link to the Storage Architecture: http://developer.couchbase.com/documentation/server/4.5/architecture/storage-architecture.html
- Link to the UI for Auto-compaction settings: http://developer.couchbase.com/documentation/server/4.5/settings/configure-compact-settings.html
- Link to the CLI for the same options (which should have the same linking back-and-forth): http://developer.couchbase.com/documentation/server/4.5/cli/cbcli/bucket-compact.html
- Similarly, it's a little bit confusing that we don't find "compaction settings" along with all the other settings of a bucket or cluster. It would be helpful if these pages had a note that said "see <here> for compaction settings":
- http://developer.couchbase.com/documentation/server/4.5/cli/cbcli/bucket-edit.html
- http://developer.couchbase.com/documentation/server/4.5/cli/cbcli/cluster-edit.html
- http://developer.couchbase.com/documentation/server/4.5/rest-api/rest-bucket-create.html
- http://developer.couchbase.com/documentation/server/4.5/rest-api/rest-bucket-parameters.html
- http://developer.couchbase.com/documentation/server/4.5/clustersetup/change-settings-bucket.html
- In general, these sort of changes (especially cross-linking and related info) would help make the docs much more useable when someone is coming in from Google and looking to perform a specific change or task, especially for the reference docs.