documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Document preflight training requirements

Open sebbacon opened this issue 5 years ago • 1 comments

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)

sebbacon avatar Jan 08 '21 16:01 sebbacon

Somehow tweak the project.yaml and perhaps the default python script to do something different, and run that locally

Suggest the standard repo is a measure for the OpenSAFELY Service Restoration Observatory e.g. cholesterol tests per 100 000 in study_defintion.

The tweak could be to add a new measure in a separate study definition which would require reading documentation and adjusting project.yaml to run 2 study defs

brianmackenna avatar Jan 13 '21 10:01 brianmackenna