caddyserver / caddyserver/website
Docs should be versioned
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- HTML
- Stars
- 227
- Forks
- 213
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 1
Description
I was trying out auto_https global opt on a v2.0 container
But it kept failing with unrecognized parameter name: auto_https.
According to https://github.com/caddyserver/caddy/issues/3219#issuecomment-631131568 this is v2.1 only
It would be nice to have such info available in the docs.
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
Review the reported auto_https version mismatch and the referenced v2.1 discussion first. Define how version-specific documentation should be represented and where users should find it; the work is done when version availability is clearly documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100