chef-workstation icon indicating copy to clipboard operation
chef-workstation copied to clipboard

Unified Command Structure

Open jonsmorrow opened this issue 3 years ago • 1 comments

Job to be Done:

As an practitioner,

I want to be able to use a consistent set of commands from my local Workstation app to do the following:

  • Manage my Chef infrastructure
  • Write & test my cookbooks
  • Upload cookbooks to the Chef server
  • Use reporting and upgrade features
  • Perform Ad Hoc node management
  • Run InSpec profiles
  • Build & test Habitat packages

Description:

Currently while all of the functionalities above are included in Workstation, they all follow their own command structure and format. This is hard to use for an end user to understand what tools to use to accomplish their goals as well as how to use those tools. Consistency across commands makes it faster for new users to learn which tools are available as well as how to best use them. It also makes use of our tools more efficient since all commands are structured in the same way. (i.e. user doesn't have to remember different command formats for different tools, they can just assume the same format applies to all commands)

Acceptance Criteria:

  1. Unifying all commands under a top level Chef command

  2. Structure all commands in a consistent manner so that the format is applicable across all of the different tools (e.g. chef test mycookbook, chef create mycookbook, chef upload myprofile, etc.)

  3. Errors behave similarly across all tools and provide a consistent way to provide feedback to Chef.

Aha! Link: https://chef.aha.io/features/SH-94

jonsmorrow avatar Oct 05 '20 21:10 jonsmorrow

Comment added by Lisa Stidham in Aha! - View

Noting Issue 1496

jonsmorrow avatar Feb 13 '21 00:02 jonsmorrow