chef / chef/chef-web-docs

Document Chef Infra Client event handler event type parameters

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

Nobody has claimed this yet.

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

Description

Description

The docs here refer to the event types available during a Chef Infra Client run :: https://docs.chef.io/handlers.html#event-types ..

It's great that those are documented, but each event type has their own set of parameters, and they are not consistent across each type ..

Documenting all of the event type parameters might be a pain, but maybe we can at least link to the code so anyone who is exploring these event types and trying to figure out which parameters are available to them can have some sort of reference to go by .. Otherwise, users will need use some sort of debugging tool to try and determine what variables are available to them ..

Here is the link to possible event types, which also define the parameters for each one :: https://github.com/chef/chef/blob/master/lib/chef/event_dispatch/base.rb ..

Just an idea and thanks for your work !!

Chef Version

Chef Infra Client

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 event types section at docs.chef.io/handlers.html#event-types and inspect lib/chef/event_dispatch/base.rb, which defines the possible event types and their parameters. Done means either documenting those parameters or adding a useful link from the event types documentation to the source reference.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.