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 a TOC to the configuration doc #1298

Closed
op-ct opened this issue Apr 25, 2022 · 0 comments · Fixed by #1299
Closed

Add a TOC to the configuration doc #1298

op-ct opened this issue Apr 25, 2022 · 0 comments · Fixed by #1299

Comments

@op-ct
Copy link
Contributor

op-ct commented Apr 25, 2022

The doc/dynamic-environments/configuration.mkd doc is structured, but it's too large to easily discern that structure. It can be difficult for users to find their way around without losing the context of the documentation they eventually find, especially for beginners.

It would helpful to add a hyperlinked table of contents to the beginning of the document (like Puppet modules's README) to give readers a roadmap to the document and an index for each option under the context of its section.
op-ct added a commit to op-ct/r10k that referenced this issue Apr 25, 2022
@op-ct
Add TOC to configuration docs
e7fdbfc 
The configuration doc is structured, but it's too large to easily
understand that structure.  It can be difficult for users to find their
way around without losing the context of the documentation they
eventually find, especially for beginners.

This patch adds a hyperlinked table of contents to the configuration
doc, to clarify the document's structure and provide an index of each
option with context.

Fixes puppetlabs#1298
@op-ct op-ct mentioned this issue Apr 25, 2022
Merged
mwaggett pushed a commit that referenced this issue May 11, 2022
@op-ct
Add TOC to configuration docs (#1299)
dbd8cc4 
Add TOC to configuration docs

The configuration doc is structured, but it's too large to easily
understand that structure.  It can be difficult for users to find their
way around without losing the context of the documentation they
eventually find, especially for beginners.

This patch adds a hyperlinked table of contents to the configuration
doc, to clarify the document's structure and provide an index of each
option with context.

Fixes #1298
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add TOC to configuration docs op-ct/r10k
1 participant
@op-ct