CfgMgmtCamp 2026 discussion (6/12): Collection documentation on Ansible Galaxy is incomplete and partially confusing

As a user

Collection documentation on Ansible Galaxy is incomplete and partially confusing

Latest developments

None that I know of. This wasn’t discussed at CfgMgmtCamp 2026.

Original text

There are some things about Ansible Galaxy’s collection documentation viewer that aren’t good:

  • Documentation of roles (from argument spec, similar than for modules and plugins) is missing (for example, see the community.sops.install “documentation” on Galaxy).
  • Modules or plugins using doc fragments from other collections are not shown at all. (Doc fragments from ansible-core or from the same collection work.)
  • The Documentation tab is grouped by modules / plugins, and “plugins” contains things like doc fragments and module utils. This is pretty much useless.
1 Like