hashicorp / hashicorp/nomad-pack

cli: add generate-docs command to generate skeleton pack readme

Open
#93 1 comment 0 reactions 0 assignees View on GitHub
hcc/jira stage/accepted theme/cli type/enhancement
Dominant language
Go
Stars
447
Forks
65
PR merge metrics
No merged PRs in 30d

Description

When authoring packs, we want to encourage writing useful documentation whilst making every effort to streamline this process. Luckily, Nomad Pack has both a way to read the root variables file, and render arbitrary templates. We could therefore use these internal processes to render a basic README based on the passed root variables and pack information.

Contributor guide

Open the contributing guide

Research direction

Start by locating the CLI command registration and the existing code that reads the root variables file and renders arbitrary templates. Trace how pack information is represented and passed through those paths. Done means a generate-docs command can use the passed root variables and pack information to produce a basic skeleton README.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.