{"action":"created","comment":{"url":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/comments/242977339","pull_request_review_id":186180869,"id":242977339,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI0Mjk3NzMzOQ==","diff_hunk":"@@ -0,0 +1,211 @@\n+# Wagtail pages\n+\n+[Wagtail pages](http://docs.wagtail.io/en/v1.13.4/topics/pages.html) are \n+[Django models](https://docs.djangoproject.com/en/1.11/topics/db/models/) \n+that are constructed of \n+[fields](#fields), [StreamFields](#streamfields), and [panels](#panels) \n+that are rendered in a standard way. \n+All CFPB Wagtail pages should inherit from the \n+[`v1.models.base.CFGOVPage` class](https://github.com/cfpb/cfgov-refresh/blob/master/cfgov/v1/models/base.py).\n+\n+!!! note\n+    Before creating a new Wagtail page type \n+    please consider whether one of our existing page types can meet your needs, \n+    whether this is a different type of content than we have anywhere else in the site, \n+    and whether there is maintenance efficiency gained from a new page type.\n+\n+There are types of information defined on a new Wagtail page model: \n+basic [database fields](#fields) (like any Django model), \n+specialized database fields called [StreamFields](#streamfields) that allow for freeform page content, \n+and [editor panels](#panels) that present these fields to content editors. ","path":"docs/wagtail-pages.md","position":20,"original_position":20,"commit_id":"3443a19eb45e440539271c4e784c52638c3daf61","original_commit_id":"3443a19eb45e440539271c4e784c52638c3daf61","user":{"login":"Scotchester","id":1044670,"node_id":"MDQ6VXNlcjEwNDQ2NzA=","avatar_url":"https://avatars3.githubusercontent.com/u/1044670?v=4","gravatar_id":"","url":"https://api.github.com/users/Scotchester","html_url":"https://github.com/Scotchester","followers_url":"https://api.github.com/users/Scotchester/followers","following_url":"https://api.github.com/users/Scotchester/following{/other_user}","gists_url":"https://api.github.com/users/Scotchester/gists{/gist_id}","starred_url":"https://api.github.com/users/Scotchester/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Scotchester/subscriptions","organizations_url":"https://api.github.com/users/Scotchester/orgs","repos_url":"https://api.github.com/users/Scotchester/repos","events_url":"https://api.github.com/users/Scotchester/events{/privacy}","received_events_url":"https://api.github.com/users/Scotchester/received_events","type":"User","site_admin":false},"body":"I think it'd be nice to make this a numbered list, but I don't feel strongly about it.","created_at":"2018-12-19T16:11:34Z","updated_at":"2018-12-19T16:53:44Z","html_url":"https://github.com/cfpb/cfgov-refresh/pull/4707#discussion_r242977339","pull_request_url":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/4707","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/comments/242977339"},"html":{"href":"https://github.com/cfpb/cfgov-refresh/pull/4707#discussion_r242977339"},"pull_request":{"href":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/4707"}}},"pull_request":{"url":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/4707","id":239194544,"node_id":"MDExOlB1bGxSZXF1ZXN0MjM5MTk0NTQ0","html_url":"https://github.com/cfpb/cfgov-refresh/pull/4707","diff_url":"https://github.com/cfpb/cfgov-refresh/pull/4707.diff","patch_url":"https://github.com/cfpb/cfgov-refresh/pull/4707.patch","issue_url":"https://api.github.com/repos/cfpb/cfgov-refresh/issues/4707","number":4707,"state":"open","locked":false,"title":"Add documentation about Wagtail page models","user":{"login":"willbarton","id":10562538,"node_id":"MDQ6VXNlcjEwNTYyNTM4","avatar_url":"https://avatars0.githubusercontent.com/u/10562538?v=4","gravatar_id":"","url":"https://api.github.com/users/willbarton","html_url":"https://github.com/willbarton","followers_url":"https://api.github.com/users/willbarton/followers","following_url":"https://api.github.com/users/willbarton/following{/other_user}","gists_url":"https://api.github.com/users/willbarton/gists{/gist_id}","starred_url":"https://api.github.com/users/willbarton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willbarton/subscriptions","organizations_url":"https://api.github.com/users/willbarton/orgs","repos_url":"https://api.github.com/users/willbarton/repos","events_url":"https://api.github.com/users/willbarton/events{/privacy}","received_events_url":"https://api.github.com/users/willbarton/received_events","type":"User","site_admin":false},"body":"This PR adds a document that describes the process of creating a new Wagtail page type via an explanation of the different aspects of a page model: Django model fields, StreamFields, editor panels, parent/child relationships, and templates. It's meant to be an referable overview, with plenty of links to more information. \r\n\r\nMissing from this document are:\r\n\r\n- *When* to create a new page type. This document, because it's an overview of the different pieces of a page, side-steps that issue. Because that's a larger decision for a team to make and not just on the developer who might be creating the page model.\r\n- Links to the the new StreamField docs in ~~#4678~~ and #4706. These will be added.\r\n\r\nThis replaces the old, useless \"Wagtail pages vs Django models\" document, which gave potentially bad, but mostly useless advice to anyone trying to create anything.\r\n\r\nRendered via GitHub: https://github.com/cfpb/cfgov-refresh/blob/wagtail-page-doc/docs/wagtail-pages.md\r\n\r\n## Checklist\r\n\r\n- [x] PR has an informative and human-readable title\r\n- [x] Changes are limited to a single goal (no scope creep)\r\n- [x] Code can be automatically merged (no conflicts)\r\n- [ ] Code follows the standards laid out in the [development playbook](https://github.com/cfpb/development)\r\n- [ ] Passes all existing automated tests\r\n- [ ] Any _change_ in functionality is tested\r\n- [ ] New functions are documented (with a description, list of inputs, and expected output)\r\n- [ ] Placeholder code is flagged / future todos are captured in comments\r\n- [ ] Visually tested in supported browsers and devices (see checklist below :point_down:)\r\n- [x] Project documentation has been updated\r\n- [x] Reviewers requested with the [Reviewers tool](https://help.github.com/articles/requesting-a-pull-request-review/) :arrow_right:\r\n","created_at":"2018-12-17T15:56:44Z","updated_at":"2018-12-19T16:53:43Z","closed_at":null,"merged_at":null,"merge_commit_sha":"fb867f87cedc79ec94748f6d05629ac6b0a47ee7","assignee":null,"assignees":[],"requested_reviewers":[{"login":"cfarm","id":702526,"node_id":"MDQ6VXNlcjcwMjUyNg==","avatar_url":"https://avatars3.githubusercontent.com/u/702526?v=4","gravatar_id":"","url":"https://api.github.com/users/cfarm","html_url":"https://github.com/cfarm","followers_url":"https://api.github.com/users/cfarm/followers","following_url":"https://api.github.com/users/cfarm/following{/other_user}","gists_url":"https://api.github.com/users/cfarm/gists{/gist_id}","starred_url":"https://api.github.com/users/cfarm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfarm/subscriptions","organizations_url":"https://api.github.com/users/cfarm/orgs","repos_url":"https://api.github.com/users/cfarm/repos","events_url":"https://api.github.com/users/cfarm/events{/privacy}","received_events_url":"https://api.github.com/users/cfarm/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/4707/commits","review_comments_url":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/4707/comments","review_comment_url":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/comments{/number}","comments_url":"https://api.github.com/repos/cfpb/cfgov-refresh/issues/4707/comments","statuses_url":"https://api.github.com/repos/cfpb/cfgov-refresh/statuses/3443a19eb45e440539271c4e784c52638c3daf61","head":{"label":"cfpb:wagtail-page-doc","ref":"wagtail-page-doc","sha":"3443a19eb45e440539271c4e784c52638c3daf61","user":{"login":"cfpb","id":1071563,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEwNzE1NjM=","avatar_url":"https://avatars2.githubusercontent.com/u/1071563?v=4","gravatar_id":"","url":"https://api.github.com/users/cfpb","html_url":"https://github.com/cfpb","followers_url":"https://api.github.com/users/cfpb/followers","following_url":"https://api.github.com/users/cfpb/following{/other_user}","gists_url":"https://api.github.com/users/cfpb/gists{/gist_id}","starred_url":"https://api.github.com/users/cfpb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfpb/subscriptions","organizations_url":"https://api.github.com/users/cfpb/orgs","repos_url":"https://api.github.com/users/cfpb/repos","events_url":"https://api.github.com/users/cfpb/events{/privacy}","received_events_url":"https://api.github.com/users/cfpb/received_events","type":"Organization","site_admin":false},"repo":{"id":18852566,"node_id":"MDEwOlJlcG9zaXRvcnkxODg1MjU2Ng==","name":"cfgov-refresh","full_name":"cfpb/cfgov-refresh","private":false,"owner":{"login":"cfpb","id":1071563,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEwNzE1NjM=","avatar_url":"https://avatars2.githubusercontent.com/u/1071563?v=4","gravatar_id":"","url":"https://api.github.com/users/cfpb","html_url":"https://github.com/cfpb","followers_url":"https://api.github.com/users/cfpb/followers","following_url":"https://api.github.com/users/cfpb/following{/other_user}","gists_url":"https://api.github.com/users/cfpb/gists{/gist_id}","starred_url":"https://api.github.com/users/cfpb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfpb/subscriptions","organizations_url":"https://api.github.com/users/cfpb/orgs","repos_url":"https://api.github.com/users/cfpb/repos","events_url":"https://api.github.com/users/cfpb/events{/privacy}","received_events_url":"https://api.github.com/users/cfpb/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/cfpb/cfgov-refresh","description":"Django project protecting American consumers","fork":false,"url":"https://api.github.com/repos/cfpb/cfgov-refresh","forks_url":"https://api.github.com/repos/cfpb/cfgov-refresh/forks","keys_url":"https://api.github.com/repos/cfpb/cfgov-refresh/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cfpb/cfgov-refresh/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cfpb/cfgov-refresh/teams","hooks_url":"https://api.github.com/repos/cfpb/cfgov-refresh/hooks","issue_events_url":"https://api.github.com/repos/cfpb/cfgov-refresh/issues/events{/number}","events_url":"https://api.github.com/repos/cfpb/cfgov-refresh/events","assignees_url":"https://api.github.com/repos/cfpb/cfgov-refresh/assignees{/user}","branches_url":"https://api.github.com/repos/cfpb/cfgov-refresh/branches{/branch}","tags_url":"https://api.github.com/repos/cfpb/cfgov-refresh/tags","blobs_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/refs{/sha}","trees_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cfpb/cfgov-refresh/statuses/{sha}","languages_url":"https://api.github.com/repos/cfpb/cfgov-refresh/languages","stargazers_url":"https://api.github.com/repos/cfpb/cfgov-refresh/stargazers","contributors_url":"https://api.github.com/repos/cfpb/cfgov-refresh/contributors","subscribers_url":"https://api.github.com/repos/cfpb/cfgov-refresh/subscribers","subscription_url":"https://api.github.com/repos/cfpb/cfgov-refresh/subscription","commits_url":"https://api.github.com/repos/cfpb/cfgov-refresh/commits{/sha}","git_commits_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/commits{/sha}","comments_url":"https://api.github.com/repos/cfpb/cfgov-refresh/comments{/number}","issue_comment_url":"https://api.github.com/repos/cfpb/cfgov-refresh/issues/comments{/number}","contents_url":"https://api.github.com/repos/cfpb/cfgov-refresh/contents/{+path}","compare_url":"https://api.github.com/repos/cfpb/cfgov-refresh/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cfpb/cfgov-refresh/merges","archive_url":"https://api.github.com/repos/cfpb/cfgov-refresh/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cfpb/cfgov-refresh/downloads","issues_url":"https://api.github.com/repos/cfpb/cfgov-refresh/issues{/number}","pulls_url":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls{/number}","milestones_url":"https://api.github.com/repos/cfpb/cfgov-refresh/milestones{/number}","notifications_url":"https://api.github.com/repos/cfpb/cfgov-refresh/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cfpb/cfgov-refresh/labels{/name}","releases_url":"https://api.github.com/repos/cfpb/cfgov-refresh/releases{/id}","deployments_url":"https://api.github.com/repos/cfpb/cfgov-refresh/deployments","created_at":"2014-04-16T19:22:03Z","updated_at":"2018-12-19T16:29:10Z","pushed_at":"2018-12-19T16:49:15Z","git_url":"git://github.com/cfpb/cfgov-refresh.git","ssh_url":"git@github.com:cfpb/cfgov-refresh.git","clone_url":"https://github.com/cfpb/cfgov-refresh.git","svn_url":"https://github.com/cfpb/cfgov-refresh","homepage":"https://www.consumerfinance.gov/","size":252299,"stargazers_count":105,"watchers_count":105,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":67,"mirror_url":null,"archived":false,"open_issues_count":65,"license":{"key":"other","name":"Other","spdx_id":"NOASSERTION","url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":67,"open_issues":65,"watchers":105,"default_branch":"master"}},"base":{"label":"cfpb:master","ref":"master","sha":"d33a52cac94b39cf98af4b357247b93b9b0d8559","user":{"login":"cfpb","id":1071563,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEwNzE1NjM=","avatar_url":"https://avatars2.githubusercontent.com/u/1071563?v=4","gravatar_id":"","url":"https://api.github.com/users/cfpb","html_url":"https://github.com/cfpb","followers_url":"https://api.github.com/users/cfpb/followers","following_url":"https://api.github.com/users/cfpb/following{/other_user}","gists_url":"https://api.github.com/users/cfpb/gists{/gist_id}","starred_url":"https://api.github.com/users/cfpb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfpb/subscriptions","organizations_url":"https://api.github.com/users/cfpb/orgs","repos_url":"https://api.github.com/users/cfpb/repos","events_url":"https://api.github.com/users/cfpb/events{/privacy}","received_events_url":"https://api.github.com/users/cfpb/received_events","type":"Organization","site_admin":false},"repo":{"id":18852566,"node_id":"MDEwOlJlcG9zaXRvcnkxODg1MjU2Ng==","name":"cfgov-refresh","full_name":"cfpb/cfgov-refresh","private":false,"owner":{"login":"cfpb","id":1071563,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEwNzE1NjM=","avatar_url":"https://avatars2.githubusercontent.com/u/1071563?v=4","gravatar_id":"","url":"https://api.github.com/users/cfpb","html_url":"https://github.com/cfpb","followers_url":"https://api.github.com/users/cfpb/followers","following_url":"https://api.github.com/users/cfpb/following{/other_user}","gists_url":"https://api.github.com/users/cfpb/gists{/gist_id}","starred_url":"https://api.github.com/users/cfpb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfpb/subscriptions","organizations_url":"https://api.github.com/users/cfpb/orgs","repos_url":"https://api.github.com/users/cfpb/repos","events_url":"https://api.github.com/users/cfpb/events{/privacy}","received_events_url":"https://api.github.com/users/cfpb/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/cfpb/cfgov-refresh","description":"Django project protecting American consumers","fork":false,"url":"https://api.github.com/repos/cfpb/cfgov-refresh","forks_url":"https://api.github.com/repos/cfpb/cfgov-refresh/forks","keys_url":"https://api.github.com/repos/cfpb/cfgov-refresh/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cfpb/cfgov-refresh/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cfpb/cfgov-refresh/teams","hooks_url":"https://api.github.com/repos/cfpb/cfgov-refresh/hooks","issue_events_url":"https://api.github.com/repos/cfpb/cfgov-refresh/issues/events{/number}","events_url":"https://api.github.com/repos/cfpb/cfgov-refresh/events","assignees_url":"https://api.github.com/repos/cfpb/cfgov-refresh/assignees{/user}","branches_url":"https://api.github.com/repos/cfpb/cfgov-refresh/branches{/branch}","tags_url":"https://api.github.com/repos/cfpb/cfgov-refresh/tags","blobs_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/refs{/sha}","trees_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cfpb/cfgov-refresh/statuses/{sha}","languages_url":"https://api.github.com/repos/cfpb/cfgov-refresh/languages","stargazers_url":"https://api.github.com/repos/cfpb/cfgov-refresh/stargazers","contributors_url":"https://api.github.com/repos/cfpb/cfgov-refresh/contributors","subscribers_url":"https://api.github.com/repos/cfpb/cfgov-refresh/subscribers","subscription_url":"https://api.github.com/repos/cfpb/cfgov-refresh/subscription","commits_url":"https://api.github.com/repos/cfpb/cfgov-refresh/commits{/sha}","git_commits_url":"https://api.github.com/repos/cfpb/cfgov-refresh/git/commits{/sha}","comments_url":"https://api.github.com/repos/cfpb/cfgov-refresh/comments{/number}","issue_comment_url":"https://api.github.com/repos/cfpb/cfgov-refresh/issues/comments{/number}","contents_url":"https://api.github.com/repos/cfpb/cfgov-refresh/contents/{+path}","compare_url":"https://api.github.com/repos/cfpb/cfgov-refresh/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cfpb/cfgov-refresh/merges","archive_url":"https://api.github.com/repos/cfpb/cfgov-refresh/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cfpb/cfgov-refresh/downloads","issues_url":"https://api.github.com/repos/cfpb/cfgov-refresh/issues{/number}","pulls_url":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls{/number}","milestones_url":"https://api.github.com/repos/cfpb/cfgov-refresh/milestones{/number}","notifications_url":"https://api.github.com/repos/cfpb/cfgov-refresh/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cfpb/cfgov-refresh/labels{/name}","releases_url":"https://api.github.com/repos/cfpb/cfgov-refresh/releases{/id}","deployments_url":"https://api.github.com/repos/cfpb/cfgov-refresh/deployments","created_at":"2014-04-16T19:22:03Z","updated_at":"2018-12-19T16:29:10Z","pushed_at":"2018-12-19T16:49:15Z","git_url":"git://github.com/cfpb/cfgov-refresh.git","ssh_url":"git@github.com:cfpb/cfgov-refresh.git","clone_url":"https://github.com/cfpb/cfgov-refresh.git","svn_url":"https://github.com/cfpb/cfgov-refresh","homepage":"https://www.consumerfinance.gov/","size":252299,"stargazers_count":105,"watchers_count":105,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":67,"mirror_url":null,"archived":false,"open_issues_count":65,"license":{"key":"other","name":"Other","spdx_id":"NOASSERTION","url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":67,"open_issues":65,"watchers":105,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/4707"},"html":{"href":"https://github.com/cfpb/cfgov-refresh/pull/4707"},"issue":{"href":"https://api.github.com/repos/cfpb/cfgov-refresh/issues/4707"},"comments":{"href":"https://api.github.com/repos/cfpb/cfgov-refresh/issues/4707/comments"},"review_comments":{"href":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/4707/comments"},"review_comment":{"href":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/cfpb/cfgov-refresh/pulls/4707/commits"},"statuses":{"href":"https://api.github.com/repos/cfpb/cfgov-refresh/statuses/3443a19eb45e440539271c4e784c52638c3daf61"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"Scotchester"}}