Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

Narrative: Using the Explain Subsystem #97

Closed
3 tasks done
michaeltlombardi opened this issue Jan 13, 2022 · 0 comments · Fixed by #112
Closed
3 tasks done

Narrative: Using the Explain Subsystem #97

michaeltlombardi opened this issue Jan 13, 2022 · 0 comments · Fixed by #112
Assignees
@michaeltlombardi
Labels
documentation Improvements or additions to documentation

Comments

@michaeltlombardi
Copy link
Contributor

michaeltlombardi commented Jan 13, 2022 •
edited
Loading

Acceptance Critera

Explain:

  • What it is
  • How to look for topics
  • How to read topics
@michaeltlombardi michaeltlombardi transferred this issue from puppetlabs/puppet-vscode Jan 13, 2022
@michaeltlombardi michaeltlombardi added the documentation Improvements or additions to documentation label Jan 13, 2022
@michaeltlombardi michaeltlombardi self-assigned this Jan 25, 2022
michaeltlombardi added a commit that referenced this issue Jan 25, 2022
@michaeltlombardi
(GH-97) Document explain subsystem
b317ee1 
This commit adds narrative documentation for using the explain subsystem;
it covers:

- what the subsystem is/is for,
- what categories of docs can be surfaced in it,
- how to read reference docs not available in it,
- how to search for topics to read,
- how to display  a specific topic,
- and how the docs are versioned.

Resolves #97.
@michaeltlombardi michaeltlombardi mentioned this issue Jan 25, 2022
Merged
petergmurphy added a commit that referenced this issue Jan 25, 2022
@petergmurphy
Merge pull request #112 from puppetlabs/gh-97/main/doc-explain
af314a6 
(GH-97) Document explain subsystem
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@michaeltlombardi michaeltlombardi

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(GH-97) Document explain subsystem puppetlabs-toy-chest/prm
1 participant
@michaeltlombardi