Jira (BOLT-1477) Inventory file v2 documentation should begin with an example

2 views
Skip to first unread message

Dylan Ratcliffe (JIRA)

unread,
Jul 22, 2019, 7:56:04 AM7/22/19
to puppe...@googlegroups.com
Dylan Ratcliffe created an issue
 
Puppet Task Runner / Improvement BOLT-1477
Inventory file v2 documentation should begin with an example
Issue Type: Improvement Improvement
Assignee: Unassigned
Components: DOCS
Created: 2019/07/22 4:55 AM
Priority: Normal Normal
Reporter: Dylan Ratcliffe

The documentation for bolt inventory files v2 is written more as a "Here's what's different from v1" rather than a piece of documentation to be taken on its own. This makes it difficult to work out how the inventory file should be structured as you need to take both pieces of documentation and combine them in your head:

v1: https://puppet.com/docs/bolt/latest/inventory_file.html

v2: https://puppet.com/docs/bolt/latest/inventory_file_v2.html

It would be better if the v2 has a full example at the beginning so that people could copy-paste-modify their way to victory instead of having to actually read the docs. Then they can read the sections the need if desired later, this is especially useful for readers who are coming back and already know what the settings do, but can't remember the exact format.

Add Comment Add Comment
 
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo
Reply all
Reply to author
Forward
0 new messages