mapbox / mapbox/tilelive

Missing documentation/explanation for tilelive-copy options

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

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
540
Forks
106
PR merge metrics
No merged PRs in 30d

Description

The "best" source of information about how tilelive-copy works is the source itself. The --help and git tree don't have many details. Some flags like --concurrency could use some explanation about how it works and --parts should have a description at the very least...

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 with the tilelive-copy source and its --help output, then compare the documented flags with the git tree. Explain how --concurrency works and add at least a description for --parts; done means the key options are understandable without reading the source.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.