puppetlabs / puppetlabs/puppet-strings

Output documentation for modulepath

Open
#269 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Ruby
Stars
90
Forks
90
PR merge metrics
No merged PRs in 30d

Description

More a Feature request than an issue. I would like to host a copy of the output for all our modules separate from the built in Yard server functionality.

So i would like to be able to run something like puppet stings generate --modulepath <path> and have it generate the site from
puppet stings server -modulepath <Path> as a folder structure that i can take away and host myself.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the requested puppet stings generate --modulepath <path> command with puppet stings server --modulepath <path> and the built-in Yard server behavior. Define how the generated folder structure should mirror the server output and verify that it can be hosted independently.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
cli, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.