Create Bolt topics pages for CLI #2078
Assignees
Labels
Feature
New features and improvements.
Comments
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 13, 2020
This adds a new CLI command, `bolt guide`, which displays information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides, use the `bolt guide` command: ``` $ bolt guide ``` To view the guide for a specific topic, use the `bolt guide <topic>` command: ``` $ bolt guide inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt topics with the `bolt guide` command** ([puppetlabs#2078](puppetlabs#2078)) The new CLI command `bolt guide` can be used to view information about different Bolt topics, such as inventory and projects. Users can view a list of available guides using the `bolt guide` command, or view a specific guide using the `bolt guide <topic>` command.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 13, 2020
This adds a new CLI command, `bolt guide`, which displays information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides, use the `bolt guide` command: ``` $ bolt guide ``` To view the guide for a specific topic, use the `bolt guide <topic>` command: ``` $ bolt guide inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt topics with the `bolt guide` command** ([puppetlabs#2078](puppetlabs#2078)) The new CLI command `bolt guide` can be used to view information about different Bolt topics, such as inventory and projects. Users can view a list of available guides using the `bolt guide` command, or view a specific guide using the `bolt guide <topic>` command.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 13, 2020
This adds a new CLI command, `bolt guide`, which displays information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides, use the `bolt guide` command: ``` $ bolt guide ``` To view the guide for a specific topic, use the `bolt guide <topic>` command: ``` $ bolt guide inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt topics with the `bolt guide` command** ([puppetlabs#2078](puppetlabs#2078)) The new CLI command `bolt guide` can be used to view information about different Bolt topics, such as inventory and projects. Users can view a list of available guides using the `bolt guide` command, or view a specific guide using the `bolt guide <topic>` command.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 13, 2020
This adds a new CLI command, `bolt guide`, which displays information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides, use the `bolt guide` command: ``` $ bolt guide ``` To view the guide for a specific topic, use the `bolt guide <topic>` command: ``` $ bolt guide inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 13, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 13, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 13, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 13, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 14, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 17, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 17, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 17, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 17, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 17, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 17, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 18, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 18, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 18, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
beechtom
added a commit
to beechtom/bolt-vanagon
that referenced
this issue
Aug 18, 2020
This adds Bolt's [topic guides](puppetlabs/bolt#2088) to the PowerShell module. It updates the Bolt component to copy the renamed topic guides from `pwsh_module/en-US` in the Bolt repo to the PowerShell module directory. It also updates a couple of WiX files to create a directory in the PowerShell module for the help pages and adds each of the help pages as a component. Part of puppetlabs/bolt#2078
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 18, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-Help about_bolt_* ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-Help about_bolt_inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide`.
beechtom
added a commit
to beechtom/bolt
that referenced
this issue
Aug 18, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-Help about_bolt_* ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-Help about_bolt_inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide`.
dontlaugh
pushed a commit
to dontlaugh/bolt
that referenced
this issue
Nov 22, 2020
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-Help about_bolt_* ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-Help about_bolt_inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Use Case
Users should be able to view help pages for Bolt topics from the CLI. For example, I'm using Bolt for the first time and receive a warning or error that tells me about a topic that I'm unfamiliar with, such as a modulepath. I should be able to use a command such as
bolt guide modulepathto have Bolt list information about what a modulepath is. The help page could potentially link to Bolt documentation as well.Having a
bolt guidecommand could help users more easily find answers to their questions on their own, as well as help surface other features and topics they may be interested in or need to learn about. For example, thebolt guidecommand could accept a--topicsoption (or something similar) to display a full list of topics that the user can display help for.This feature would also pair nicely with #1465 (adding a glossary page), as the help text for each topic could be used in both places.
We should print a message advertising this when users run
bolt helpat the bottom of the output.bolt guideandbolt help guide/bolt guide --helpshould all list available topicsbolt guide inventoryandbolt guide projectwould be good guides to start with.The text was updated successfully, but these errors were encountered: