Document "scratch" mountpoint
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 57
- Forks
- 165
- Avg merge
- 1m
- Merged PRs (30d)
- 2
Description
Hey,
In https://github.com/concourse/concourse/issues/1045, there was the initial work to have /scratch, a mountpoint that allows one to bypass overlay and have a direct mount to the underlying filesystem (that overlay sits on top of).
While that detail is leveraged by resources like docker-image-resource, that is not documented in ci.concourse-ci.org.
Having this mount point documented under our docs could then allow folks to more easily discover this future and work around problems that overlay might cause once we migrate from btrfs as a default preference in detect to overlay (see https://github.com/concourse/concourse/issues/4071).
Thanks!
Contributor guide
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
The target is the ci.concourse-ci.org documentation; first locate the section describing worker or container mount points. Document that /scratch bypasses overlay and mounts the underlying filesystem, including its use by docker-image-resource and its relevance to overlay-related problems. Done when readers can discover and understand when to use this mountpoint.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100