opensafely / opensafely/documentation

Consider pulling in information from other repositories

Open
#236 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Ideally, we want to avoid duplication between the OpenSAFELY documentation and individual repositories. This reduces extra work in maintaining the same content in multiple places. It would also means you don't have the potential for one source being outdated.

For instance, there currently is a copy-paste of part of the output-publisher README in this part of the docs (under "Click here to read in more detail about the osrelease command.")

Thoughts from Tech Team meeting 💭

  • It is useful for the OpenSAFELY documentation to contain information about tools. This information is not otherwise easily accessible on firewalled servers. That information may be duplicated from elsewhere.
  • It is good for developers writing information about their software to have that close to them for managing it. That is, keeping this documentation repository as the single source is additional work for developers to frequently switch to maintain.

If it is possible to configure mkdocs to pull information from these other sources, in the same way that cohort extractor docstrings are included, this might solve the problem. Maybe this all goes into the Reference section of the documentation?

Questions ❓

  • Which repositories are of interest?
  • What information specifically do we want to pull in? This might be some combination of READMEs and/or docstrings and/or something else.
  • How can we configure mkdocs to do this?

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 comparing the duplicated content in docs/releasing-files.md with the linked output-publisher README, then review the issue's questions about repositories, source content, and mkdocs configuration. Done should mean the sources and content to import are agreed and a documented approach for including them in the documentation is established.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.