Jira (BOLT-1261) Common debugging and best practices documents

Issue Type:	Task
Assignee:	Unassigned
Created:	2019/04/21 9:24 AM
Priority:	Normal
Reporter:	Lucy Wyman

2 ideas for documentation that's been asked for frequently:
1. Common issues and how to debug them - this came up when someone was getting a "bolt can't find that task" error, and mentioned we should record common things to try when you encounter this error.
2. A Bolt best practices doc. It might be too early in Bolt development to start this, but a document like https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html that links to other docmentation in Bolt would be useful. For example, we get the question of how to structure a project directory pretty frequently. We might need to think about improving SEO in that case, or linking to the project directory page from a 'Best Practices' page.

This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)

Lucy Wyman (JIRA)

unread,

May 2, 2019, 12:52:03 PM5/2/19

to puppe...@googlegroups.com

Lucy Wyman updated an issue

Change By:	Lucy Wyman

2 ideas for documentation that's been asked for frequently:
1. Common issues and how to debug them - this came up when someone was getting a "bolt can't find that task" error, and mentioned we should record common things to try when you encounter this error.

a. Bolt can't find a task
b. can’t find gem bolt (>= 0.a) with executable bolt (Gem::GemNotFoundException)

2. A Bolt best practices doc. It might be too early in Bolt development to start this, but a document like https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html that links to other docmentation in Bolt would be useful. For example, we get the question of how to structure a project directory pretty frequently. We might need to think about improving SEO in that case, or linking to the project directory page from a 'Best Practices' page.

Lucy Wyman (JIRA)

unread,

May 28, 2019, 12:46:04 PM5/28/19

to puppe...@googlegroups.com

Lucy Wyman commented on

Re: Common debugging and best practices documents

Note to Lucy: make ticket for 2. A Bolt best practices doc. It might be too early in Bolt development to start this, but a document like https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html that links to other docmentation in Bolt would be useful. For example, we get the question of how to structure a project directory pretty frequently. We might need to think about improving SEO in that case, or linking to the project directory page from a 'Best Practices' page.

Lucy Wyman (JIRA)

unread,

May 28, 2019, 12:48:03 PM5/28/19

to puppe...@googlegroups.com

Lucy Wyman updated an issue

Change By:	Lucy Wyman

2 ideas for documentation that's been asked for frequently:

1. Common issues This should be a minimal list of common errors and how common ways to debug or fix them - . For example: this came up when someone was getting a "bolt can't find that task" error, and mentioned we should record common things to try when you encounter this error.

a. Bolt can't find a task
b. can’t find gem bolt (>= 0.a) with executable bolt (Gem::GemNotFoundException)

2. A Bolt best practices doc. It might This can be too early in Bolt development added to start this, but a document like https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html that links to other docmentation as issues come up in Bolt would be useful Slack . For example, we get the question of how to structure This is also a project directory pretty frequently. We might need to think about improving SEO in that case, or linking to the project directory page from a good place for "we run into this issue and don ' Best Practices' page t know why" .

Lucy Wyman (JIRA)

unread,

May 28, 2019, 12:48:03 PM5/28/19

to puppe...@googlegroups.com

Lucy Wyman updated an issue