Skip to content

Implement periodic review system#102

Merged
tijmenb merged 1 commit into
masterfrom
automated-reviews
Apr 12, 2017
Merged

Implement periodic review system#102
tijmenb merged 1 commit into
masterfrom
automated-reviews

Conversation

@tijmenb

@tijmenb tijmenb commented Apr 10, 2017

Copy link
Copy Markdown
Contributor

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 force-pushed the automated-reviews branch from 503b340 to ba357ca Compare April 10, 2017 12:36
@tijmenb tijmenb temporarily deployed to govuk-tech-docs-pr-102 April 10, 2017 12:36 Inactive
@tijmenb tijmenb force-pushed the automated-reviews branch from ba357ca to 1724352 Compare April 10, 2017 12:41
@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 force-pushed the automated-reviews branch from 1724352 to 05fa029 Compare April 12, 2017 08:59
@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 force-pushed the automated-reviews branch from 05fa029 to ec91a59 Compare April 12, 2017 09:06
@tijmenb tijmenb temporarily deployed to govuk-tech-docs-pr-102 April 12, 2017 09:06 Inactive
Comment thread source/manual.html.erb Outdated

<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
Copy Markdown
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
Copy Markdown
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.

Comment thread source/manual/ab-testing.html.md Outdated
parent: /manual.html
layout: manual_layout
section: Tools
owner: Tijmen

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
Contributor

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

@tijmenb tijmenb force-pushed the automated-reviews branch from ec91a59 to 4c3040d Compare April 12, 2017 11:58
@tijmenb tijmenb temporarily deployed to govuk-tech-docs-pr-102 April 12, 2017 11:58 Inactive
@tijmenb

tijmenb commented Apr 12, 2017

Copy link
Copy Markdown
Contributor Author

@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
@tijmenb tijmenb force-pushed the automated-reviews branch from 75901a7 to 9ab9c61 Compare April 12, 2017 12:09
@tijmenb tijmenb had a problem deploying to govuk-tech-docs-pr-102 April 12, 2017 12:10 Failure

@whoojemaflip whoojemaflip left a comment

Copy link
Copy Markdown
Contributor

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.

2 participants