opensafely / opensafely/documentation
Enhancement request: Update docs about Installing Docker
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
Original: https://github.com/opensafely-core/job-server/issues/5944
Summary
Docs about installing Docker may need to be updated
What would you like to achieve?
User flagged that the instructions are confusing / outdated - for instance, in these two screenshots the same information is repeated twice but in a slightly different way. In the current version of Docker, the "shared drives" setting doesn't exist
- review instructions about Installing Docker and update for consistency and accuracy
Who would benefit and how?
Users working locally - having consistent instructions to install Docker as part of working locally will reduce frustration for users and allow them to optimise their setup when using OpenSAFELY.
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
Start with the Installing Docker instructions at docs.opensafely.org/install-docker/ and compare the sections and screenshots mentioned in the issue. Review the current Docker interface and identify duplicated, inconsistent, or outdated guidance, including the referenced shared drives setting. Done means the local-install instructions are accurate and consistent for users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100