opensafely / opensafely/documentation

Document preflight training requirements

Open
#92 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new content
Dominant language
Python
Stars
48
Forks
10
Avg merge
2d 19h
Merged PRs (30d)
17

Description

We'll want to link new external users to some page in the documentation that walks them through all the things we require them to do before we kick off their support period.

Much of this is already in the docs, but we want some kind of checklist or something.

Something along these lines:

  • Complete some kind of git tutorial?
  • Install Github Desktop, Docker (not version 3 I think! @HelenCEBM and @esnightingale both had issues with the latest one), Python
  • Install a decent text editor with syntax highlighting for python and yaml joy
  • Install opensafely-cli and successfully run opensafely --version
  • Clone the repo the OpenSAFELY team will have set up for you
  • Run opensafely run run_all and observe the output
  • Somehow tweak the project.yaml and perhaps the default python script to do something different, and run that locally
  • Push the change to your repo and observe the tests passing
  • Access our Level 4 server (optional)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing documentation and identify where a new external user would begin. Use the listed setup steps, including opensafely --version, opensafely run run_all, project.yaml, and the default Python script, to define a linkable checklist; done means the preflight requirements are gathered into one clear page.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, git, github, python
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.