opensafely / opensafely/documentation
Tidy installation guides
Open
Nobody has claimed this yet.
improve content
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
I spotted a couple of things with the installation guides which could be improved:
- They might be promoted to an upper level in the documentation hierarchy.
- There is some overlap and duplication between installations described per operating system (Windows, macOS, Linux), and per piece of software (Git, Docker, OpenSAFELY CLI). We should tidy this in future.
For now, I think it's fine to leave as is, and resolve collectively as an entire section.
Originally posted by @StevenMaude in https://github.com/opensafely/documentation/issues/810#issuecomment-1157669534
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 by reviewing the installation guides and their current documentation hierarchy. Map the overlap between operating-system guides and software-specific guides, then propose a consistent section structure. Done means the installation documentation has been reorganized as one coherent section without duplicated guidance.
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