Skip to content

Commit

Permalink
Provide access to last updated date
Browse files Browse the repository at this point in the history
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
  • Loading branch information
yndajas committed May 9, 2023
1 parent c7af7fc commit 87d5d71
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ gem "jekyll", "~> 4.3.2"

# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-last-modified-at"
gem "jekyll-redirect-from"
gem "jekyll-sass-converter", github: 'jekyll/jekyll-sass-converter'
gem "jekyll-sitemap"
Expand Down
5 changes: 5 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ GEM
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-last-modified-at (1.3.0)
jekyll (>= 3.7, < 5.0)
posix-spawn (~> 0.3.9)
jekyll-redirect-from (0.16.0)
jekyll (>= 3.3, < 5.0)
jekyll-sitemap (1.4.0)
Expand Down Expand Up @@ -89,6 +92,7 @@ GEM
hashery (~> 2.0)
ruby-rc4
ttfunk
posix-spawn (0.3.15)
public_suffix (5.0.1)
racc (1.6.2)
rainbow (3.1.1)
Expand Down Expand Up @@ -123,6 +127,7 @@ PLATFORMS
DEPENDENCIES
html-proofer
jekyll (~> 4.3.2)
jekyll-last-modified-at
jekyll-redirect-from
jekyll-sass-converter!
jekyll-sitemap
Expand Down
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,6 @@ sass:
- ../node_modules/*

plugins:
- jekyll-last-modified-at
- jekyll-redirect-from
- jekyll-sitemap

0 comments on commit 87d5d71

Please sign in to comment.