docs/config-params-guc-list is incomplete
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- postgresql
- Domain
- databases, documentation
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.
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_thresholdlock_timeoutmax_slot_wal_keep_sizelog_*
List of useful parameters with no mentioning in Cloudberry documentation:
gp_add_column_inherits_table_settinggp_max_plan_sizegp_max_slicesgp_resource_group_memory_limitmaster_shared_buffersmax_locks_per_transactionsegment_shared_buffers
For some of them - are just Postgres GUCs, some - Cloudberry-specific.
- Dominant language
- TypeScript
- Stars
- 26
- Forks
- 43
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 4
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/cloudberry-site
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
apache/cloudberry-site#323 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
apache/cloudberry-site#401 · 2 comments ·
-
apache/cloudberry-site#316 · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
apache/cloudberry-site#297 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
apache/cloudberry-site#296 ·
All issues in apache/cloudberry-site
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·