Jira (BOLT-1541) Bolt docs improvement regarding example code

7 views
Skip to first unread message

Mike Smith (Jira)

unread,
Mar 9, 2020, 6:39:04 PM3/9/20
to puppe...@googlegroups.com
Mike Smith created an issue
 
Puppet Task Runner / Improvement BOLT-1541
Bolt docs improvement regarding example code
Issue Type: Improvement Improvement
Assignee: Unassigned
Components: bolt, DOCS
Created: 2020/03/09 3:38 PM
Priority: Normal Normal
Reporter: Mike Smith

Any time there is an example of code for a given bolt workflow, feature, function, or best practice there should be an example in each common scripting language.  Currently there is often only a ruby example. Most operations teams that would attempt to on-board bolt would not typically write administrative scripts in ruby but already have them in bash, powershell, or python.  Given each of these options it will be make the on-boarding and first experience with Bolt more user friendly. 

Current pain point is with error handling for bash.  The docs give ruby examples for error handling https://puppet.com/docs/bolt/latest/writing_tasks.html#returning-errors-in-tasks however I would need now look up error handling in bash to modify my code, then guess how to wrap that for a Bolt task specifically.  

Add Comment Add Comment
 
This message was sent by Atlassian Jira (v8.5.2#805002-sha1:a66f935)
Atlassian logo

Ryan RussellYates (Jira)

unread,
Mar 9, 2020, 7:24:04 PM3/9/20
to puppe...@googlegroups.com
Ryan RussellYates commented on Improvement BOLT-1541
 
Re: Bolt docs improvement regarding example code

I'm with Mike on this one. Basing it on customers in the field, our example pyramid is completely upside down. My anecdotal findings in the field:

  • Bash and Powershell are everywhere. This is the universal default for scripts for nearly every organization. This is where 90%+ of the workforce of our customers are comfortable.
  • Python steps up to the plate once we start talking about arrays and hashes (because Bash is particularly bad at this). Python is also super sharable thanks to strict syntax. The huge library of available code also pushes people here occasionally. Generally a few talented people at an organization write Python and the other ops folks act as consumers of their scripts.
  • Rubyists at orgs write more Python than Ruby. Non-Rubyists won't dive any further than a basic fact (and that takes them nearly a year of writing Puppet to attempt on their own). 

 

I'd rather see bash and powershell treated as first class citizens in our documentation, and Ruby and Python treated as the heavy-lifting scripting language, rather than the default. With Python as the default language (like our customers use).

 

People problems in scripting are harder than tech problems.

Jarret Lavallee (Jira)

unread,
May 7, 2020, 4:26:02 PM5/7/20
to puppe...@googlegroups.com
Jarret Lavallee updated an issue
 
Change By: Jarret Lavallee
CS Priority: Needs Priority Reviewed

Alex Dreyer (Jira)

unread,
May 27, 2020, 4:18:04 PM5/27/20
to puppe...@googlegroups.com
Reply all
Reply to author
Forward
0 new messages