opensafely-core / opensafely-core/opencodelists

Document all manual and automated import processes

Open
#2,949 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
60
Forks
16
Avg merge
4d 12h
Merged PRs (30d)
17

Description

Why are we doing this?

OpenCodelists has import processes for a number of coding system and mapping files updates. These are mostly automated, but some are still (partly) manual. Where they've been automated, they're run as cron jobs, but these are handled outside of dokku and can be hard to find/view.

See 🧵 thread for examples of where we're currently lacking in documentation.

See also https://github.com/opensafely-core/opencodelists/issues/2948.

How will we know when it's done?

Members of Team REX can easily find out what import processes we have and how they're currently working.

What are we doing?

  • Documenting what import processes for coding systems and mapping files we have, including where to find them on dokku3 and how they're monitored (e.g for debugging purposes).
  • Documenting when manual processes need to take place, which could include Slack reminders.
  • Documenting how each of the manual processes are done (if not already documented).

Defining delivery tasks guidance

Contributor guide

No contributing guide indexed for this repository

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 with the examples in the linked Slack thread and issue #2948 to inventory the coding-system and mapping-file import processes, including cron jobs and their dokku3 locations. Document how each is monitored or debugged, when manual steps occur, and how they are performed; done means Team REX can find and understand every process.

Written by the indexing model from the issue text.

Assessment

Domain
devops, 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.