chef / chef/chef-web-docs

Clarify documentation for git/scm resources `user` attribute

Open
#4,252 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

Description

https://github.com/chef/chef-web-docs/blob/7ec349e7de03d5e69c71ec1c90b318425b35876c/data/infra/resources/git.yaml#L202-L207

Please clarify whether the git command actually executes as the listed user, or whether it simply CHMODs the files after the fact?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with data/infra/resources/git.yaml at lines 202-207 and read the documented user attribute in context. Verify whether the wording distinguishes command execution from post-command file permissions, then update the documentation so that behavior is unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.