chef / chef/chef-web-docs

chef_handler resource still directs users to use deprecated chef_handler cookbook

Open Beginner friendly
#2,123 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

User Story

As a chef user trying to remediate the "WARN: chef_handler::default recipe has been deprecated. Use the chef_handler resource instead to define handlers from your own wrapper cookbook." messages by rewriting our custom handlers, I read the chef_handler resource page and am directed to download the deprecated chef_handlers cookbook.

Description

chef_handlers cookbook is deprecated but under the Custom Handlers heading on the chef_handler resource documentation page, step 1 is "Download the chef_handler cookbook"

Chef Version

chef client 14.13.11

Definition of Done

Documentation accurately documents how to create custom handlers.

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

Open the chef_handler resource documentation page and find the Custom Handlers heading. Replace the step directing users to download the deprecated chef_handlers cookbook with accurate custom-handler instructions; the definition of done is documentation that correctly explains how to create custom handlers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
82/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.