letsencrypt / letsencrypt/pebble

Documentation: mention that when using with release binary, you should copy the test folder

Open
#309 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
787
Forks
176
PR merge metrics
No merged PRs in 30d

Description

When I first tried to get Pebble running using the binary I downloaded from the releases, it complained about missing files it was looking for. I got it working by copying the test directory from the source repository into the same folder as the Pebble binary. With that, I was able to run Pebble without needing to specify any arguments.

This would be useful to document for people just starting out with Pebble to improve their initial experience.

Related: #308

Contributor guide

No contributing guide indexed for this repository

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 locating the documentation for running the release binary and review the release layout described in the issue, including the test directory. Done means the getting-started guidance explains that the test folder must be copied beside the Pebble binary for running without arguments.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.