This directory contains the markdown files used to generate the official Bolt Documentation. To make changes to most of Bolt's documentation, you can edit the corresponding markdown file directly. However, some of Bolt's documentation is generated as part of the release process and requires edits to either Bolt's source code or to the template used to generate the documentation.
Several pages of Bolt's documentation are generated as part of Bolt's release
process and do not have markdown files in this directory. Each of the generated
pages has an associated Embedded Ruby template located in the
templates directory as well as a rake task
that is used to generate the documentation. Each rake task retrieves data from
Bolt's source code and sends it to a rendering engine that generates a markdown
file from the template. The generated markdown file is saved to the
documentation directory.
You can generate all documentation using the following rake task:
$ bundle exec rake docs:allHere are each of the documenation pages that are generated, the files that you might need to modify to make changes to the generated documentation, and the rake task used to generate the documentation.
Documentation page
Template file
Relevant source code
To generate this documentation, run:
$ bundle exec rake docs:command_referenceDocumentation page
Template file
Relevant source code
To generate this documentation, run:
$ bundle exec rake docs:cmdlet_referenceDocumentation page
Template file
Relevant source code
The rake task for this page uses puppet-strings to generate documentation
from comments in a function's source code. Bolt ships with several core modules
that are located in the bolt-modules directory. To modify the documentation
for a plan function, locate its file and modify the comments.
To generate this documentation, run:
$ bundle exec rake docs:function_referenceDocumentation page
Template file
Relevant source code
To generate this documentation, run:
$ bundle exec rake docs:defaults_referenceDocumentation page
Template file
Relevant source code
To generate this documentation, run:
$ bundle exec rake docs:project_referenceDocumentation page
Template file
Relevant source code
config/transport/(Each transport defines its available options.)config/transport/options.rb
To generate this documentation, run:
$ bundle exec rake docs:transports_referenceDocumentation page
Template file
Relevant source code
To generate this documentation, run:
$ bundle exec rake docs:privilege_escalation