{"action":"created","comment":{"url":"https://api.github.com/repos/writethedocs/www/pulls/comments/239185012","pull_request_review_id":181905699,"id":239185012,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIzOTE4NTAxMg==","diff_hunk":"@@ -5,6 +5,27 @@ about the Write the Docs group, as well as information about writing documentati\n \n To contribute to the Write the Docs website, it's helpful to familiarize yourself with the [Sphinx site generator](https://www.sphinx-doc.org/), as well as [reStructuredText markup syntax](https://www.sphinx-doc.org/en/stable/rest.html).\n \n+### Code Architecture\n+\n+All of the generated website lives inside the `docs` directory.\n+We are trying to move towards a more data driven approach,\n+which allows for easier maintenance and reuse of content between events.\n+\n+#### Conference pages\n+\n+We have a few important directories and files:\n+\n+* `_data/config-portland-2019.yaml` - This file contains the data for rendering a specific conference.\n+* `_templates/2019/` - Contains the HTML templates for the website for a conference for that year.\n+* `conf/portland/2019/` - Contains the RST files that we use for rendering the conference.\n+* `include/conf/` Contains the text snippets which are the same between all conferences, mostly describing what our events are (eg. lightning talks and unconference). They are included via the RST files for each event.\n+* `_ext/core.py` Contains the Sphinx extensions that manage injecting custom variables into our RST and Jinja templates. Specifically the `rstjinja` and `load_page_yaml_data` functions do a lot of the work.\n+\n+All files that live under the `conf` directory are rendered in a special way.\n+We automatically inject the data inside the `_data/config-<location>-<year>.yaml` file into the Jinja context for the RST files.","path":"README.md","position":21,"original_position":21,"commit_id":"32078fb7268f992d116723d4576c4b39c8f9af67","original_commit_id":"32078fb7268f992d116723d4576c4b39c8f9af67","user":{"login":"plaindocs","id":95874,"node_id":"MDQ6VXNlcjk1ODc0","avatar_url":"https://avatars2.githubusercontent.com/u/95874?v=4","gravatar_id":"","url":"https://api.github.com/users/plaindocs","html_url":"https://github.com/plaindocs","followers_url":"https://api.github.com/users/plaindocs/followers","following_url":"https://api.github.com/users/plaindocs/following{/other_user}","gists_url":"https://api.github.com/users/plaindocs/gists{/gist_id}","starred_url":"https://api.github.com/users/plaindocs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/plaindocs/subscriptions","organizations_url":"https://api.github.com/users/plaindocs/orgs","repos_url":"https://api.github.com/users/plaindocs/repos","events_url":"https://api.github.com/users/plaindocs/events{/privacy}","received_events_url":"https://api.github.com/users/plaindocs/received_events","type":"User","site_admin":false},"body":"```suggestion\r\n the data inside the `_data/config-<location>-<year>.yaml` file in the Jinja context for the RST files.\r\n```","created_at":"2018-12-05T18:32:29Z","updated_at":"2018-12-05T18:34:20Z","html_url":"https://github.com/writethedocs/www/pull/748#discussion_r239185012","pull_request_url":"https://api.github.com/repos/writethedocs/www/pulls/748","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/writethedocs/www/pulls/comments/239185012"},"html":{"href":"https://github.com/writethedocs/www/pull/748#discussion_r239185012"},"pull_request":{"href":"https://api.github.com/repos/writethedocs/www/pulls/748"}}},"pull_request":{"url":"https://api.github.com/repos/writethedocs/www/pulls/748","id":236255715,"node_id":"MDExOlB1bGxSZXF1ZXN0MjM2MjU1NzE1","html_url":"https://github.com/writethedocs/www/pull/748","diff_url":"https://github.com/writethedocs/www/pull/748.diff","patch_url":"https://github.com/writethedocs/www/pull/748.patch","issue_url":"https://api.github.com/repos/writethedocs/www/issues/748","number":748,"state":"open","locked":false,"title":"Talk a bit about how we render the conference pages magically","user":{"login":"ericholscher","id":25510,"node_id":"MDQ6VXNlcjI1NTEw","avatar_url":"https://avatars2.githubusercontent.com/u/25510?v=4","gravatar_id":"","url":"https://api.github.com/users/ericholscher","html_url":"https://github.com/ericholscher","followers_url":"https://api.github.com/users/ericholscher/followers","following_url":"https://api.github.com/users/ericholscher/following{/other_user}","gists_url":"https://api.github.com/users/ericholscher/gists{/gist_id}","starred_url":"https://api.github.com/users/ericholscher/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ericholscher/subscriptions","organizations_url":"https://api.github.com/users/ericholscher/orgs","repos_url":"https://api.github.com/users/ericholscher/repos","events_url":"https://api.github.com/users/ericholscher/events{/privacy}","received_events_url":"https://api.github.com/users/ericholscher/received_events","type":"User","site_admin":false},"body":null,"created_at":"2018-12-05T17:14:22Z","updated_at":"2018-12-05T18:34:20Z","closed_at":null,"merged_at":null,"merge_commit_sha":"d4656fa124eaec7cfa01656682afc7344889fd29","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/writethedocs/www/pulls/748/commits","review_comments_url":"https://api.github.com/repos/writethedocs/www/pulls/748/comments","review_comment_url":"https://api.github.com/repos/writethedocs/www/pulls/comments{/number}","comments_url":"https://api.github.com/repos/writethedocs/www/issues/748/comments","statuses_url":"https://api.github.com/repos/writethedocs/www/statuses/32078fb7268f992d116723d4576c4b39c8f9af67","head":{"label":"writethedocs:arch-docs","ref":"arch-docs","sha":"32078fb7268f992d116723d4576c4b39c8f9af67","user":{"login":"writethedocs","id":3220763,"node_id":"MDEyOk9yZ2FuaXphdGlvbjMyMjA3NjM=","avatar_url":"https://avatars2.githubusercontent.com/u/3220763?v=4","gravatar_id":"","url":"https://api.github.com/users/writethedocs","html_url":"https://github.com/writethedocs","followers_url":"https://api.github.com/users/writethedocs/followers","following_url":"https://api.github.com/users/writethedocs/following{/other_user}","gists_url":"https://api.github.com/users/writethedocs/gists{/gist_id}","starred_url":"https://api.github.com/users/writethedocs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/writethedocs/subscriptions","organizations_url":"https://api.github.com/users/writethedocs/orgs","repos_url":"https://api.github.com/users/writethedocs/repos","events_url":"https://api.github.com/users/writethedocs/events{/privacy}","received_events_url":"https://api.github.com/users/writethedocs/received_events","type":"Organization","site_admin":false},"repo":{"id":7723911,"node_id":"MDEwOlJlcG9zaXRvcnk3NzIzOTEx","name":"www","full_name":"writethedocs/www","private":false,"owner":{"login":"writethedocs","id":3220763,"node_id":"MDEyOk9yZ2FuaXphdGlvbjMyMjA3NjM=","avatar_url":"https://avatars2.githubusercontent.com/u/3220763?v=4","gravatar_id":"","url":"https://api.github.com/users/writethedocs","html_url":"https://github.com/writethedocs","followers_url":"https://api.github.com/users/writethedocs/followers","following_url":"https://api.github.com/users/writethedocs/following{/other_user}","gists_url":"https://api.github.com/users/writethedocs/gists{/gist_id}","starred_url":"https://api.github.com/users/writethedocs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/writethedocs/subscriptions","organizations_url":"https://api.github.com/users/writethedocs/orgs","repos_url":"https://api.github.com/users/writethedocs/repos","events_url":"https://api.github.com/users/writethedocs/events{/privacy}","received_events_url":"https://api.github.com/users/writethedocs/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/writethedocs/www","description":"The main website for Write the Docs. ","fork":false,"url":"https://api.github.com/repos/writethedocs/www","forks_url":"https://api.github.com/repos/writethedocs/www/forks","keys_url":"https://api.github.com/repos/writethedocs/www/keys{/key_id}","collaborators_url":"https://api.github.com/repos/writethedocs/www/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/writethedocs/www/teams","hooks_url":"https://api.github.com/repos/writethedocs/www/hooks","issue_events_url":"https://api.github.com/repos/writethedocs/www/issues/events{/number}","events_url":"https://api.github.com/repos/writethedocs/www/events","assignees_url":"https://api.github.com/repos/writethedocs/www/assignees{/user}","branches_url":"https://api.github.com/repos/writethedocs/www/branches{/branch}","tags_url":"https://api.github.com/repos/writethedocs/www/tags","blobs_url":"https://api.github.com/repos/writethedocs/www/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/writethedocs/www/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/writethedocs/www/git/refs{/sha}","trees_url":"https://api.github.com/repos/writethedocs/www/git/trees{/sha}","statuses_url":"https://api.github.com/repos/writethedocs/www/statuses/{sha}","languages_url":"https://api.github.com/repos/writethedocs/www/languages","stargazers_url":"https://api.github.com/repos/writethedocs/www/stargazers","contributors_url":"https://api.github.com/repos/writethedocs/www/contributors","subscribers_url":"https://api.github.com/repos/writethedocs/www/subscribers","subscription_url":"https://api.github.com/repos/writethedocs/www/subscription","commits_url":"https://api.github.com/repos/writethedocs/www/commits{/sha}","git_commits_url":"https://api.github.com/repos/writethedocs/www/git/commits{/sha}","comments_url":"https://api.github.com/repos/writethedocs/www/comments{/number}","issue_comment_url":"https://api.github.com/repos/writethedocs/www/issues/comments{/number}","contents_url":"https://api.github.com/repos/writethedocs/www/contents/{+path}","compare_url":"https://api.github.com/repos/writethedocs/www/compare/{base}...{head}","merges_url":"https://api.github.com/repos/writethedocs/www/merges","archive_url":"https://api.github.com/repos/writethedocs/www/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/writethedocs/www/downloads","issues_url":"https://api.github.com/repos/writethedocs/www/issues{/number}","pulls_url":"https://api.github.com/repos/writethedocs/www/pulls{/number}","milestones_url":"https://api.github.com/repos/writethedocs/www/milestones{/number}","notifications_url":"https://api.github.com/repos/writethedocs/www/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/writethedocs/www/labels{/name}","releases_url":"https://api.github.com/repos/writethedocs/www/releases{/id}","deployments_url":"https://api.github.com/repos/writethedocs/www/deployments","created_at":"2013-01-21T00:23:18Z","updated_at":"2018-12-05T16:40:09Z","pushed_at":"2018-12-05T17:15:33Z","git_url":"git://github.com/writethedocs/www.git","ssh_url":"git@github.com:writethedocs/www.git","clone_url":"https://github.com/writethedocs/www.git","svn_url":"https://github.com/writethedocs/www","homepage":"http://www.writethedocs.org","size":123789,"stargazers_count":729,"watchers_count":729,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":246,"mirror_url":null,"archived":false,"open_issues_count":45,"license":{"key":"other","name":"Other","spdx_id":"NOASSERTION","url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":246,"open_issues":45,"watchers":729,"default_branch":"master"}},"base":{"label":"writethedocs:master","ref":"master","sha":"97893190e0b8f0778983c439781699ceb8ea90f9","user":{"login":"writethedocs","id":3220763,"node_id":"MDEyOk9yZ2FuaXphdGlvbjMyMjA3NjM=","avatar_url":"https://avatars2.githubusercontent.com/u/3220763?v=4","gravatar_id":"","url":"https://api.github.com/users/writethedocs","html_url":"https://github.com/writethedocs","followers_url":"https://api.github.com/users/writethedocs/followers","following_url":"https://api.github.com/users/writethedocs/following{/other_user}","gists_url":"https://api.github.com/users/writethedocs/gists{/gist_id}","starred_url":"https://api.github.com/users/writethedocs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/writethedocs/subscriptions","organizations_url":"https://api.github.com/users/writethedocs/orgs","repos_url":"https://api.github.com/users/writethedocs/repos","events_url":"https://api.github.com/users/writethedocs/events{/privacy}","received_events_url":"https://api.github.com/users/writethedocs/received_events","type":"Organization","site_admin":false},"repo":{"id":7723911,"node_id":"MDEwOlJlcG9zaXRvcnk3NzIzOTEx","name":"www","full_name":"writethedocs/www","private":false,"owner":{"login":"writethedocs","id":3220763,"node_id":"MDEyOk9yZ2FuaXphdGlvbjMyMjA3NjM=","avatar_url":"https://avatars2.githubusercontent.com/u/3220763?v=4","gravatar_id":"","url":"https://api.github.com/users/writethedocs","html_url":"https://github.com/writethedocs","followers_url":"https://api.github.com/users/writethedocs/followers","following_url":"https://api.github.com/users/writethedocs/following{/other_user}","gists_url":"https://api.github.com/users/writethedocs/gists{/gist_id}","starred_url":"https://api.github.com/users/writethedocs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/writethedocs/subscriptions","organizations_url":"https://api.github.com/users/writethedocs/orgs","repos_url":"https://api.github.com/users/writethedocs/repos","events_url":"https://api.github.com/users/writethedocs/events{/privacy}","received_events_url":"https://api.github.com/users/writethedocs/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/writethedocs/www","description":"The main website for Write the Docs. ","fork":false,"url":"https://api.github.com/repos/writethedocs/www","forks_url":"https://api.github.com/repos/writethedocs/www/forks","keys_url":"https://api.github.com/repos/writethedocs/www/keys{/key_id}","collaborators_url":"https://api.github.com/repos/writethedocs/www/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/writethedocs/www/teams","hooks_url":"https://api.github.com/repos/writethedocs/www/hooks","issue_events_url":"https://api.github.com/repos/writethedocs/www/issues/events{/number}","events_url":"https://api.github.com/repos/writethedocs/www/events","assignees_url":"https://api.github.com/repos/writethedocs/www/assignees{/user}","branches_url":"https://api.github.com/repos/writethedocs/www/branches{/branch}","tags_url":"https://api.github.com/repos/writethedocs/www/tags","blobs_url":"https://api.github.com/repos/writethedocs/www/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/writethedocs/www/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/writethedocs/www/git/refs{/sha}","trees_url":"https://api.github.com/repos/writethedocs/www/git/trees{/sha}","statuses_url":"https://api.github.com/repos/writethedocs/www/statuses/{sha}","languages_url":"https://api.github.com/repos/writethedocs/www/languages","stargazers_url":"https://api.github.com/repos/writethedocs/www/stargazers","contributors_url":"https://api.github.com/repos/writethedocs/www/contributors","subscribers_url":"https://api.github.com/repos/writethedocs/www/subscribers","subscription_url":"https://api.github.com/repos/writethedocs/www/subscription","commits_url":"https://api.github.com/repos/writethedocs/www/commits{/sha}","git_commits_url":"https://api.github.com/repos/writethedocs/www/git/commits{/sha}","comments_url":"https://api.github.com/repos/writethedocs/www/comments{/number}","issue_comment_url":"https://api.github.com/repos/writethedocs/www/issues/comments{/number}","contents_url":"https://api.github.com/repos/writethedocs/www/contents/{+path}","compare_url":"https://api.github.com/repos/writethedocs/www/compare/{base}...{head}","merges_url":"https://api.github.com/repos/writethedocs/www/merges","archive_url":"https://api.github.com/repos/writethedocs/www/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/writethedocs/www/downloads","issues_url":"https://api.github.com/repos/writethedocs/www/issues{/number}","pulls_url":"https://api.github.com/repos/writethedocs/www/pulls{/number}","milestones_url":"https://api.github.com/repos/writethedocs/www/milestones{/number}","notifications_url":"https://api.github.com/repos/writethedocs/www/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/writethedocs/www/labels{/name}","releases_url":"https://api.github.com/repos/writethedocs/www/releases{/id}","deployments_url":"https://api.github.com/repos/writethedocs/www/deployments","created_at":"2013-01-21T00:23:18Z","updated_at":"2018-12-05T16:40:09Z","pushed_at":"2018-12-05T17:15:33Z","git_url":"git://github.com/writethedocs/www.git","ssh_url":"git@github.com:writethedocs/www.git","clone_url":"https://github.com/writethedocs/www.git","svn_url":"https://github.com/writethedocs/www","homepage":"http://www.writethedocs.org","size":123789,"stargazers_count":729,"watchers_count":729,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":246,"mirror_url":null,"archived":false,"open_issues_count":45,"license":{"key":"other","name":"Other","spdx_id":"NOASSERTION","url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":246,"open_issues":45,"watchers":729,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/writethedocs/www/pulls/748"},"html":{"href":"https://github.com/writethedocs/www/pull/748"},"issue":{"href":"https://api.github.com/repos/writethedocs/www/issues/748"},"comments":{"href":"https://api.github.com/repos/writethedocs/www/issues/748/comments"},"review_comments":{"href":"https://api.github.com/repos/writethedocs/www/pulls/748/comments"},"review_comment":{"href":"https://api.github.com/repos/writethedocs/www/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/writethedocs/www/pulls/748/commits"},"statuses":{"href":"https://api.github.com/repos/writethedocs/www/statuses/32078fb7268f992d116723d4576c4b39c8f9af67"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"plaindocs"}}