DFE-Digital / dfe-job-descriptions

A collection of DfE Job Descriptions. Published at https://dfe-digital.github.io/dfe-job-descriptions/
8 stars 9 forks source link

Convert to GOV.UK tech docs #22

Closed duncanjbrown closed 2 years ago

duncanjbrown commented 2 years ago

This repo functions well as a collection of job descriptions, but it has two shortcomings

1) it is difficult to compare job descriptions (for consistency) by clicking around in the GitHub UI 2) many of the JDs have content in common, which we should be able to standardise & template

This pull request makes a step towards fixing both those things by incorporating just the JDs for software development into the GOV.UK Tech Docs template, and putting that in a subfolder alongside the existing Markdown files. Once we've standardised the Software Developer JDs we can remove those old Markdown files and keep the Markdown files we've got in here.

Then we can do the same for other professions.

Note that the GOV.UK tech docs template uses plain Markdown files; there is no barrier to entry for those who would rather view things on GitHub, or would like to contribute. Indeed, there are instant benefits: GOV.UK tech docs provides a friendly web UI for viewing (and reviewing!) JDs. As the navigation component of GOV.UK Tech Docs parses headings in Markdown files, it immediately points up inconsistencies in how we're describing roles:

Screenshot 2022-02-15 at 22 34 15

Because Middleman (the static site generator which powers GOV.UK Tech Docs) supports templating and partials, this change enables us to work to pull out common parts of JDs. I have a vague idea that we could somehow mark bits of a given JD that come from a template, so it's extremely clear what's boilerplate and what's not.

Out of scope for this PR

Interesting decisions to make about the JDs

duncanjbrown commented 2 years ago

Updated to put the tech docs in a subfolder, with a plan to migrate profession-by-profession

jonodrew commented 2 years ago

This looks awesome Duncan!

duncanjbrown commented 2 years ago

This looks awesome Duncan!

Thanks! Want to hit approve?

duncanjbrown commented 2 years ago

🎉 thanks!