Show update and review dates under title on Playbook pages #1135
Comments
|
Yup - I don't think this is formally happening
|
According to the playbook[1]: > The owner of each section of the Playbook should lead a review of the sections they own at least every quarter > > To help facilitate regular review, we should aim for Playbook content to include last updated and last reviewed dates. The latter is not currently done, and the former is likely not done consistently. Doing the latter will help us track how well we're meeting the expectations we set out for reviewing playbook content on a regular basis @johnwaterworth raised an issue related to this: #1135 --- This gem allows us to get the date of the last git commit on the file for a given page, or failing that when the file itself was modified. This will feed the last updated information on each page I would have liked to include a default time format in the config, but this didn't work using the syntax in the gem's README[2] [1]: https://playbook.dxw.com/contributing/managing-the-playbook/#review [2]: https://github.com/gjtorikian/jekyll-last-modified-at#setting-up
|
@johnwaterworth see #1138 and the preview here: https://deploy-preview-1138--laughing-payne-b9fbd2.netlify.app |
|
Should this also be expanded upon to include some automation and notifications around checking review dates, setting review periods, and who or which teams are responsible for reviewing content? I'm not sure we could use this GDS tool out of the box, but I was thinking something similar to this: https://technology.blog.gov.uk/2020/09/25/keeping-tech-docs-up-to-date-with-daniel-the-manual-spaniel/ |
According to the playbook[1]: > The owner of each section of the Playbook should lead a review of the sections they own at least every quarter > > To help facilitate regular review, we should aim for Playbook content to include last updated and last reviewed dates. The latter is not currently done, and the former is likely not done consistently. Doing the latter will help us track how well we're meeting the expectations we set out for reviewing playbook content on a regular basis @johnwaterworth raised an issue related to this: #1135 --- This gem allows us to get the date of the last git commit on the file for a given page, or failing that when the file itself was modified. This will feed the last updated information on each page I would have liked to include a default time format in the config, but this didn't work using the syntax in the gem's README[2] [1]: https://playbook.dxw.com/contributing/managing-the-playbook/#review [2]: https://github.com/gjtorikian/jekyll-last-modified-at#setting-up
We tried in the past to encourage groups to regularly review and update content in the Playbook. Showing last updated and last reviewed dates on pages would help encourage this.
Always show the date that a page was last updated (last_modified in Netlify, I think). Underneath the title seems like the best place. Although it could go in footnote.
Also show an optional review date. Updating the page should remove the last review date. There should be some way to add or update a review date, when you've done a review.
The text was updated successfully, but these errors were encountered: