Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add 'Glossary' page #1465

Closed
beechtom opened this issue Dec 4, 2019 · 2 comments · Fixed by #2989
Closed

Add 'Glossary' page #1465

beechtom opened this issue Dec 4, 2019 · 2 comments · Fixed by #2989
Assignees
@artlawson
Labels
Docs Documentation, hands-on lab, and examples.
Milestone
Docs Refresh

Comments

@beechtom
Copy link
Contributor

beechtom commented Dec 4, 2019 •
edited
Loading

Describe the Change You Would Like

Bolt should have a glossary of terms used in the Bolt documentation (e.g. target, plan, task, etc).

Questions

  • Should terms have links to relevant pages? For example, an entry for task might link to documentation for writing and using tasks.
  • What are the terms we want to list?
@beechtom beechtom added the Docs Documentation, hands-on lab, and examples. label Dec 4, 2019
@beechtom beechtom added this to the Docs Refresh milestone Dec 4, 2019
@hestonhoffman
Copy link
Contributor

Example of one of our other glossaries: https://puppet.com/docs/puppet/latest/glossary.html

@beechtom beechtom mentioned this issue Aug 12, 2020
Closed
@hestonhoffman
Copy link
Contributor

Some terms (in no particular order):

  • Bolt controller
  • Target
  • module
  • modulepath
  • project
  • inventory.yaml / inventory file
  • bolt-project.yaml / bolt project file
  • plan
  • task
  • apply
  • transport
  • TargetSpec

beechtom added a commit to beechtom/bolt that referenced this issue Mar 24, 2021
@beechtom
(puppetlabsGH-1465) Add glossary of Bolt terms
43853a3 
!no-release-note
@artlawson artlawson self-assigned this Aug 9, 2021
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 17, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
78402db 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 19, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
ea0600e 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 19, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
2f22171 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 19, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
0f979cb 
!no-release-note
@artlawson artlawson linked a pull request Aug 19, 2021 that will close this issue
(GH-1465) Add glossary of bolt terms #2989
Merged
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 19, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
3ca471f 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 19, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
e3e1caf 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 19, 2021
@beechtom
(puppetlabsGH-1465) Add glossary of Bolt terms
d089e50 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 19, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
b6fcdc1 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 19, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
3b85c60 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 20, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
1b9e95f 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 25, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
cb22c8c 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 26, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
162abd1 
!no-release-note
artlawson pushed a commit to artlawson/bolt that referenced this issue Aug 27, 2021
(puppetlabsGH-1465) Add glossary of bolt terms
5fe1a02 
!no-release-note
beechtom added a commit that referenced this issue Sep 1, 2021
@beechtom
Merge pull request #2989 from artlawson/1465/glossary
ca0442d 
(GH-1465) Add glossary of bolt terms
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@artlawson artlawson

Labels
Docs Documentation, hands-on lab, and examples.
Projects
None yet
Milestone
Docs Refresh
Development

Successfully merging a pull request may close this issue.

(GH-1465) Add glossary of bolt terms artlawson/bolt
3 participants
@hestonhoffman @beechtom @artlawson