Skip to content

docs: align users-groups example YAMLs with comment text#6865

Closed
0xdeadd wants to merge 1 commit into
canonical:mainfrom
0xdeadd:docs/fix-users-groups-examples
Closed

docs: align users-groups example YAMLs with comment text#6865
0xdeadd wants to merge 1 commit into
canonical:mainfrom
0xdeadd:docs/fix-users-groups-examples

Conversation

@0xdeadd
Copy link
Copy Markdown

@0xdeadd 0xdeadd commented May 5, 2026

Proposed Commit Message

docs: align users-groups example YAMLs with comment text

Examples 3 and 4 in the cc_users_groups module docs describe
behavior (password-based login rejected, SSH access for the GitHub
user TheRealFalcon and the Launchpad user falcojr) that the actual
YAML examples didn't include.

Add the missing lock_passwd and ssh_import_id fields so the
rendered example matches the prose. Inline-array syntax for
ssh_import_id matches the existing convention in
cc_ssh_import_id/example1.yaml and cc_users_groups/example7.yaml.

Fixes GH-6857

Summary

The example3 and example4 comments in doc/module-docs/cc_users_groups/data.yaml describe two behaviors that are missing from the corresponding YAML files:

  1. "Password-based login is rejected" → lock_passwd: true was absent
  2. "the GitHub user TheRealFalcon and the Launchpad user falcojr can SSH as newsuper" → ssh_import_id was absent

This PR adds the two fields to both example3.yaml and example4.yaml so the rendered docs match the prose.

Test Plan

  • No code changes — docs only
  • YAML still parses (verified locally)
  • Inline-array form for `ssh_import_id` matches existing examples in `cc_ssh_import_id/example1.yaml` and `cc_users_groups/example7.yaml`

Checklist

Fixes #6857

Examples 3 and 4 in the cc_users_groups module docs describe
behavior (password-based login rejected, SSH access for the GitHub
user TheRealFalcon and the Launchpad user falcojr) that the actual
YAML examples didn't include.

Add the missing lock_passwd and ssh_import_id fields so the
rendered example matches the prose. Inline-array syntax for
ssh_import_id matches the existing convention in
cc_ssh_import_id/example1.yaml and cc_users_groups/example7.yaml.

Fixes canonicalGH-6857
@github-actions github-actions Bot added the documentation This Pull Request changes documentation label May 5, 2026
@blackboxsw
Copy link
Copy Markdown
Collaborator

thank you for the submission @0xdeadd. I believe we already have a pull request in progress that is attempting to address this fix in #6858. If there is something else not covered in that pull request please feel free to comment on that PR instead. I'll close this PR in the meantime while we await resolution and merge of the prior PR.

@blackboxsw blackboxsw closed this May 6, 2026
@neitsab
Copy link
Copy Markdown
Contributor

neitsab commented May 6, 2026

I had pondered as well about the "Password-based login is rejected" in example 3.

I left it alone in my PR because the docs say it is true by default (and so not having it in the code example does not exactly qualify as a bug), but it's true that I found it a bit puzzling at first why the explanation would say "Password-based login is rejected" and then not have a matching directive.

So maybe this PR can be amended to build upon mine (that has now been merged) and simply add lock_passwd: true to example3.yml to make it really explicit, even though it's the default?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This Pull Request changes documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs]: Users and Groups module schema examples code blocks differ from explanation text

3 participants