apache / apache/cloudberry-site
docs/config-params-guc-list is incomplete
- Dominant language
- TypeScript
- Stars
- 26
- Forks
- 42
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 7
Description
Hi!
My colleagues and I was writing user-facing documentation, and we found out that `docs/config-params-guc-list` is incomplete. Many useful parameters are not documented.
List of parameters that referenced in docs, but not in guc-list:
* `gp_cached_segworkers_threshold`
* `lock_timeout`
* `max_slot_wal_keep_size`
* `log_*`
List of useful parameters with no mentioning in Cloudberry documentation:
* `gp_add_column_inherits_table_setting`
* `gp_max_plan_size`
* `gp_max_slices`
* `gp_resource_group_memory_limit`
* `master_shared_buffers`
* `max_locks_per_transaction`
* `segment_shared_buffers`
For some of them - are just Postgres GUCs, some - Cloudberry-specific.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with docs/config-params-guc-list and compare its entries with the parameters named in the issue and the documentation references. Check which PostgreSQL and Cloudberry-specific parameters belong in the list, then update the documentation so all confirmed useful parameters are represented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgresql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100