opensafely / opensafely/documentation
Add a date or commit ID somewhere to published HTML
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
@iaindillingham spotted that the docs weren't being published.
We only had an email notification of failure. Render doesn't seem to display a publish check here on GitHub. (I checked on Render and not sure there's anything there to configure.)
Cloudflare Pages does display status here, for when we switch back, #754, but it might still be useful to have an easy validation in-page that content is current. And useful for readers too, as a warning that content may be old.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the publishing setup and the generated HTML path, starting with how the docs are deployed on Render; Cloudflare Pages and issue #754 provide context for the deployment switch. Decide whether a date or commit ID should be shown, where readers should see it, and verify that a published page displays a value that identifies the current content.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100