caddyserver / caddyserver/website
Docs should include JSON Examples
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 227
- Forks
- 213
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 1
Description
I really enjoy working with the caddy admin API, but the documentation is not supportive at all. Currently, I have to submit a full Caddyfile to a test server in order to reverse engineer the logic of the JSON format of the different features.
For some reason the docs emphasise on the Caddyfile format, only. However, it is not possible to push partial Caddyfiles to the API because the admin API accepts only JSON documents. As for many features it is not at all clear where they should go in the JSON format, it would be really helpful to include basic JSON examples, too.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the website's Caddyfile-focused documentation and the Caddy admin API material described in the issue. Done means adding basic JSON examples for the relevant features so users can understand where configuration belongs without submitting a full Caddyfile.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100