puppetlabs / puppetlabs/puppet-resource_api

Notes from hands-on-lab user testing

Open
#251 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation enhancement
Dominant language
Ruby
Stars
27
Forks
42
PR merge metrics
No merged PRs in 30d

Description

These notes were taken in a ux research session 2019-12-17 and need to be folded into the hands-on-lab:

  • no chance to early test - is the API working? how to judge success after a step?

  • request_debug exercise at the end? maybe mark as more advanced content

  • add steps to verify being able to talk to hub/emulator without puppet

  • "link button press" when starting out

  • step 6: hub1.conf - what the f?

  • step 6: explain where to locate the attributes hash

  • step 6: remove 'ensure' from attributes example

  • step 6: replace DESC heredoc with regular string

  • step 6: add require 'faraday'

  • hue_put context argument does not line up with other examples

  • fix default bri value in traffic_lights.pp to something more bright (250?)

  • add --trace --verbose --debug everywhere to improve debugging when things go wrong

  • note that lights in a non-plain-color mode will not react to just setting hue/bri

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

Locate the hands-on-lab content and review the listed usability notes, especially step 6, the request_debug and hue_put examples, and traffic_lights.pp. Check each requested explanation, verification step, debugging option, example correction, and light-behavior note, then confirm the lab is understandable and testable from start to finish.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.