Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement periodic review system #102

Merged
merged 1 commit into from Apr 12, 2017
Merged

Implement periodic review system #102

merged 1 commit into from Apr 12, 2017

Conversation

tijmenb
Copy link
Contributor

@tijmenb tijmenb commented Apr 10, 2017

This adds a system to keep track of pages that need to be updated.

  • Every page can have a expire_by and owner_slack attribute
  • When its set we will show this information at the bottom of the page
  • A week before the page is set to expire, the page title appears under "Pages to be reviewed soon" on the manual homepage
  • After the page is expired the page with display a warning on the top of the page indicating that it may no longer be accurate
  • The expired page is also listed under "Expired pages" on the manuals page

screen shot 2017-04-12 at 10 05 19
screen shot 2017-04-12 at 10 05 24
screen shot 2017-04-12 at 10 06 01

https://trello.com/c/ZUd0ITTZ

@tijmenb tijmenb temporarily deployed to govuk-tech-docs-pr-102 April 10, 2017 12:34 Inactive
@tijmenb tijmenb temporarily deployed to govuk-tech-docs-pr-102 April 10, 2017 12:36 Inactive
@tijmenb tijmenb temporarily deployed to govuk-tech-docs-pr-102 April 10, 2017 12:42 Inactive
@tijmenb tijmenb changed the title Implement periodic review system [WIP] Implement periodic review system Apr 11, 2017
@tijmenb tijmenb temporarily deployed to govuk-tech-docs-pr-102 April 12, 2017 08:59 Inactive
@tijmenb tijmenb changed the title [WIP] Implement periodic review system Implement periodic review system Apr 12, 2017
@tijmenb tijmenb temporarily deployed to govuk-tech-docs-pr-102 April 12, 2017 09:06 Inactive

<p>Everyone on GOV.UK is responsible for keeping the opsmanual up to date. To ensure
this, every page should have a named owner. This person will be pinged whenever a page
threatens to go out of date.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this true? It sounds faintly menacing!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, we haven't got that yet. Removed the sentence until the bot exists.

@@ -3,6 +3,8 @@ title: Run an A/B test
parent: /manual.html
layout: manual_layout
section: Tools
owner: Tijmen
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this need to be your slack username?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, updated.

@whoojemaflip
Copy link
Contributor

I feel this should link to a page in the dev manual explaining the review process in more detail...

@tijmenb
Copy link
Contributor Author

tijmenb commented Apr 12, 2017

@whoojemaflip the review doc is currently being drafted:
https://docs.google.com/document/d/1DfFZWnUHje4SSKSMa_wWRQdwWdA0akT6iUeCHe6Vvn4/edit

We'll definitely add it once finished.

This adds a system to keep track of pages that need to be updated.

- Every page can have a `expire_by` and `owner_slack` attribute
- When its set we will show this information at the bottom of the page
- A week before the page is set to expire, the page title appears under
"Pages to be reviewed soon" on the manual homepage
- After the page is expired the page with display a warning on the top
of the page indicating that it may no longer be accurate
- The page is also listed under "Expired pages"

https://trello.com/c/ZUd0ITTZ
Copy link
Contributor

@whoojemaflip whoojemaflip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@tijmenb tijmenb merged commit 0116028 into master Apr 12, 2017
@tijmenb tijmenb deleted the automated-reviews branch April 12, 2017 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants
https://github.com/alphagov/govuk-developer-docs/pull/102
github.com
CC-MAIN-2023-40
317595
application/http; msgtype=response
sha1:DRIR7KXIOQ5WWH7WMK67QKU6BZQVPCSM
<urn:uuid:bf3fd3bb-db82-45fa-bde4-2f90f0e51f5d>
2023-09-24T20:11:58Z
140.82.114.4
text/html
sha1:GPFY3IO2HMRVRKIHGQV2FFRNFAMV6OX6
<urn:uuid:eddb1400-656c-423f-b370-5ebe77511626>
https://github.com/alphagov/govuk-developer-docs/pull/102
response
<urn:uuid:8c7a692b-fdf2-433a-88bb-c09f213f8701>
isPartOf: CC-MAIN-2023-40
publisher: Common Crawl
description: Wide crawl of the web for September/October 2023
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-16
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.5-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/