Skip to content

doc: use tables for groups.conf settings and upcalls#671

Open
thiell wants to merge 1 commit into
clustershell:masterfrom
thiell:docs/groups-conf-tables
Open

doc: use tables for groups.conf settings and upcalls#671
thiell wants to merge 1 commit into
clustershell:masterfrom
thiell:docs/groups-conf-tables

Conversation

@thiell

@thiell thiell commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Make the groups.conf reference easier to read in config.rst:

  • convert the [Main] settings and the five group-source upcalls (map, mapall, all, list, reverse) from bullet lists to tables, matching the clush.conf Settings table
  • each cell starts with a short bold summary, details follow
  • editorial pass on the groups.conf sections for grammar and clarity; fix a confdir/autodir copy-paste typo; note that YAML group files are faster than upcall-based sources
  • small theme_overrides.css addition to restore spacing between paragraphs in table cells (the RTD theme collapses it)
  • apply the typo and grammar fixes to the groups.conf(5) man page (regenerated with docutils 0.20.1, content-only diff)

Rendered and reviewed on a ReadTheDocs test project; -W builds clean with both the current pins (sphinx 6.2.1) and the #669 pins (sphinx 9.1.0).

Replace hard-to-read bullet lists in config.rst with tables matching
the clush.conf Settings table. Editorial pass for grammar and clarity.
Add spacing between paragraphs in table cells. Apply matching fixes to
the groups.conf(5) man page.

Signed-off-by: Stephane Thiell <stephane@thiell.com>
@thiell thiell added this to the 1.10.1 milestone Jul 15, 2026
@thiell thiell self-assigned this Jul 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant