chef / chef/chef-web-docs

docs should cover how to make a `code_generator` cookbook

Open
#2,073 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Aspect: Documentation Component: Chef Infra Client
Dominant language
HTML
Stars
143
Forks
438
Avg merge
1d 10h
Merged PRs (30d)
16

Description

User Story

As a user, I want to customize how chef generate generates things. The docs say I can point it to a cookbook, but provide no sample cookbooks, nor point to the embedded cookbook.

Description

The docs should provide guidance on building a custom code_generator cookbook. Maybe this is somewhere I missed it, but I couldn't find it.

Chef Version

N/A

Platform Version

Ubuntu 18.04

Definition of Done

It is documented, or this is updated with the doc I missed.

Demo Script / Repro Steps

N/A

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 the documentation for chef generate and locate the references to a code_generator cookbook and the embedded cookbook. Check whether guidance or sample cookbooks already exist elsewhere in the documentation. Done means the docs explain how to build a custom code_generator cookbook, or link clearly to the existing guidance.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.