This more goes to a topic I’ve had many times on t...
# puppet
c
This more goes to a topic I’ve had many times on the old Puppet slack…. It’s a personally held value, and puts the onus on the developer/documentarian to put out the effort, but it’s what I’ve always called the “grandma rule” when it comes to documentation. “Knowing nothing about the underlying technology, someone approaching a documentation set (such as my grandmother) should be able to follow the directions from #1…n and when all the steps enumerated in the documentation are complete, the project/product/application should be functioning.” A more technical description might be “the runbooking of user documentation”. For instance, at theforeman.org, I select the “quickstart” documentation. In the “Select Operating System” section, the dropdown only offers “Enterprise Linux 9", “Debian 12”, and “Ubuntu 22.04". What if I have Enterprise Linux 8? Does this mean everything up to Enterprise Linux 9? What about EL10? It’s been out since May. Does this include Alma? Rocky? Only RHEL? CentOS? The docs state its been tested on Alma 8, CentOS8/9 This simple paragraph and dropdown instantiates considerably more questions than it answers. (this is the biggest problem with Puppet documentation over the years, too) As if that isn’t bad enough, the documentation states “The Foreman Installer uses Puppet (6 or later required) to install foreman. Wait, I thought Foreman will install Puppet. How is it Puppet is required for the foreman installer to use to install Puppet? What does this even mean? It says the docs assume you have a newly installed operating system on which the installer will setup foreman, a Puppet Server, and the Smart Proxy by default. Wait, I thought I needed at least Puppet 6 or later to install Foreman. That implies it’s installed already, but Foreman installs Puppeet Server. And for that matter, what is a “Smart Proxy” and why would I need one? Folks, I’ve been at the UNIX/Linux game for 35 years. I’m published. I’ve written for Linux.com, Puppet, and Apress, and have taught at the local community college and trained Linux users for 20+ years and Puppet users for over 6 years back in the Puppet “heyday”. I’m not being obtuse here…If I can’t make sense of this documentation, what hope does a new user (or “grandma”) even have? Until this project’s entire documentation effort is completely reworked, it’s not worth the effort. I can do Roles/Profiles using Hiera for classification with an ENC for environment selection and PuppetBoard for visualization and simple “inifile” entires to manage the puppet.conf and be done. The GUI is intriguing. The additional info and visualizations seem wonderful. The additional tools (hammer, etc.) offers interesting options. The documentation alone makes the effort not worth my time.