Page expiry and review
It’s possible to include frontmatter configuration for a page to set an
expiration date for a piece of content. The expiration date is calculated using the
review_in frontmatter configuration parameters.
show_expiry parameter in the global configuration file decides if the banners at the bottom of the page say that the page is expired or not.
show_expiry: true, the banner at the bottom turns red if it’s past the expiration date.
If the page doesn’t need to be reviewed, we show a blue box with the last-reviewed date, when it needs review again, and the owner.
If the page needs to be reviewed, we show a red box saying the page might not be accurate.
show_expiry: false generates a blue banner with the last reviewed date. This banner stays the same whether the page needs to be reviewed or not. The banner does not mention when the page needs to be reviewed next or who the owner is.
If you want to disable the banners, but keep the review dates in the frontmatter, add the following to your global configuration file:
The page review banner will no longer appear at the bottom of the page, but Daniel the Manual Spaniel will still notify you about expired pages.
These attributes determine the date when the page needs to be reviewed next.
--- last_reviewed_on: 2018-01-18 review_in: 6 weeks ---
You can use this in combination with
set an owner for the page.
The Slack username or channel of the page owner. This can be used to appoint an individual or team as responsible for keeping the page up to date.
The Slack workspace name used when linking to the Slack owner of a piece of content. If not provided, the owner of a piece of content (channel or user) won’t be linked.
The default Slack user or channel name to show as the owner of a piece of
content. Can be overridden using the
owner_slack frontmatter config option.
The expiry date for each page is also shown in the
representation of all pages. This is used by the
tech-docs-monitor to post
messages to Slack when pages have expired.