{"action":"created","comment":{"url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/comments/66934013","id":66934013,"diff_hunk":"@@ -1,8 +1,13 @@\n # Clearwater Configuration Options Reference\n \n-This document describes all the Clearwater configuration options that can be set in /etc/clearwater/shared_config, /etc/clearwater/local_config or /etc/clearwater/user_settings.\n+This document describes all the Clearwater configuration options that can be set in `/etc/clearwater/shared_config`, `/etc/clearwater/local_config` or `/etc/clearwater/user_settings`.\n \n-You should follow [this process](Modifying_Clearwater_settings.md) when changing most of these settings. However for settings in the \"Local settings\" or \"User settings\" you should:\n+At a high level, these files contain the following types of configuration options:\n+* `shared_config` - This file holds settings that are common across the entire deployment.","path":"docs/Clearwater_Configuration_Options_Reference.md","position":8,"original_position":8,"commit_id":"706f7c1a49b22d74f1648f1e72becd46ee14a050","original_commit_id":"706f7c1a49b22d74f1648f1e72becd46ee14a050","user":{"login":"johadalin","id":14074163,"avatar_url":"https://avatars.githubusercontent.com/u/14074163?v=3","gravatar_id":"","url":"https://api.github.com/users/johadalin","html_url":"https://github.com/johadalin","followers_url":"https://api.github.com/users/johadalin/followers","following_url":"https://api.github.com/users/johadalin/following{/other_user}","gists_url":"https://api.github.com/users/johadalin/gists{/gist_id}","starred_url":"https://api.github.com/users/johadalin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/johadalin/subscriptions","organizations_url":"https://api.github.com/users/johadalin/orgs","repos_url":"https://api.github.com/users/johadalin/repos","events_url":"https://api.github.com/users/johadalin/events{/privacy}","received_events_url":"https://api.github.com/users/johadalin/received_events","type":"User","site_admin":false},"body":"It may worth stating at this point that changes to this file should and will be synchronised across the whole deployment. \r\n'Changes should by synchronised using <script>, and will trigger a rolling restart of the deployment where necessary. See more on this [here]' ","created_at":"2016-06-14T09:08:58Z","updated_at":"2016-06-14T09:08:58Z","html_url":"https://github.com/Metaswitch/clearwater-readthedocs/pull/185#discussion_r66934013","pull_request_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/185","_links":{"self":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/comments/66934013"},"html":{"href":"https://github.com/Metaswitch/clearwater-readthedocs/pull/185#discussion_r66934013"},"pull_request":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/185"}}},"pull_request":{"url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/185","id":73392010,"html_url":"https://github.com/Metaswitch/clearwater-readthedocs/pull/185","diff_url":"https://github.com/Metaswitch/clearwater-readthedocs/pull/185.diff","patch_url":"https://github.com/Metaswitch/clearwater-readthedocs/pull/185.patch","issue_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/185","number":185,"state":"open","locked":false,"title":"[Reviewer: Adam] Add a high level comment saying what the file types are","user":{"login":"eleanor-merry","id":5425325,"avatar_url":"https://avatars.githubusercontent.com/u/5425325?v=3","gravatar_id":"","url":"https://api.github.com/users/eleanor-merry","html_url":"https://github.com/eleanor-merry","followers_url":"https://api.github.com/users/eleanor-merry/followers","following_url":"https://api.github.com/users/eleanor-merry/following{/other_user}","gists_url":"https://api.github.com/users/eleanor-merry/gists{/gist_id}","starred_url":"https://api.github.com/users/eleanor-merry/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eleanor-merry/subscriptions","organizations_url":"https://api.github.com/users/eleanor-merry/orgs","repos_url":"https://api.github.com/users/eleanor-merry/repos","events_url":"https://api.github.com/users/eleanor-merry/events{/privacy}","received_events_url":"https://api.github.com/users/eleanor-merry/received_events","type":"User","site_admin":false},"body":"This PR adds a high level definition of the local_config, user_settings and shared_config files (before the rest of the doc describes the contents of the file in detail).","created_at":"2016-06-10T15:30:26Z","updated_at":"2016-06-14T09:08:58Z","closed_at":null,"merged_at":null,"merge_commit_sha":"83481fe6e7cc084f2bb00713d0c3a5dce571e846","assignee":{"login":"johadalin","id":14074163,"avatar_url":"https://avatars.githubusercontent.com/u/14074163?v=3","gravatar_id":"","url":"https://api.github.com/users/johadalin","html_url":"https://github.com/johadalin","followers_url":"https://api.github.com/users/johadalin/followers","following_url":"https://api.github.com/users/johadalin/following{/other_user}","gists_url":"https://api.github.com/users/johadalin/gists{/gist_id}","starred_url":"https://api.github.com/users/johadalin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/johadalin/subscriptions","organizations_url":"https://api.github.com/users/johadalin/orgs","repos_url":"https://api.github.com/users/johadalin/repos","events_url":"https://api.github.com/users/johadalin/events{/privacy}","received_events_url":"https://api.github.com/users/johadalin/received_events","type":"User","site_admin":false},"milestone":null,"commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/185/commits","review_comments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/185/comments","review_comment_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/185/comments","statuses_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/statuses/706f7c1a49b22d74f1648f1e72becd46ee14a050","head":{"label":"Metaswitch:add_file_defs","ref":"add_file_defs","sha":"706f7c1a49b22d74f1648f1e72becd46ee14a050","user":{"login":"Metaswitch","id":453759,"avatar_url":"https://avatars.githubusercontent.com/u/453759?v=3","gravatar_id":"","url":"https://api.github.com/users/Metaswitch","html_url":"https://github.com/Metaswitch","followers_url":"https://api.github.com/users/Metaswitch/followers","following_url":"https://api.github.com/users/Metaswitch/following{/other_user}","gists_url":"https://api.github.com/users/Metaswitch/gists{/gist_id}","starred_url":"https://api.github.com/users/Metaswitch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Metaswitch/subscriptions","organizations_url":"https://api.github.com/users/Metaswitch/orgs","repos_url":"https://api.github.com/users/Metaswitch/repos","events_url":"https://api.github.com/users/Metaswitch/events{/privacy}","received_events_url":"https://api.github.com/users/Metaswitch/received_events","type":"Organization","site_admin":false},"repo":{"id":30247023,"name":"clearwater-readthedocs","full_name":"Metaswitch/clearwater-readthedocs","owner":{"login":"Metaswitch","id":453759,"avatar_url":"https://avatars.githubusercontent.com/u/453759?v=3","gravatar_id":"","url":"https://api.github.com/users/Metaswitch","html_url":"https://github.com/Metaswitch","followers_url":"https://api.github.com/users/Metaswitch/followers","following_url":"https://api.github.com/users/Metaswitch/following{/other_user}","gists_url":"https://api.github.com/users/Metaswitch/gists{/gist_id}","starred_url":"https://api.github.com/users/Metaswitch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Metaswitch/subscriptions","organizations_url":"https://api.github.com/users/Metaswitch/orgs","repos_url":"https://api.github.com/users/Metaswitch/repos","events_url":"https://api.github.com/users/Metaswitch/events{/privacy}","received_events_url":"https://api.github.com/users/Metaswitch/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Metaswitch/clearwater-readthedocs","description":"Source repository for Clearwater's ReadTheDocs.org documentation","fork":false,"url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs","forks_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/forks","keys_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/teams","hooks_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/hooks","issue_events_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/events{/number}","events_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/events","assignees_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/assignees{/user}","branches_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/branches{/branch}","tags_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/tags","blobs_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/refs{/sha}","trees_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/statuses/{sha}","languages_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/languages","stargazers_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/stargazers","contributors_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/contributors","subscribers_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/subscribers","subscription_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/subscription","commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/commits{/sha}","git_commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/commits{/sha}","comments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/comments{/number}","issue_comment_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/comments{/number}","contents_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/contents/{+path}","compare_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/merges","archive_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/downloads","issues_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues{/number}","pulls_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls{/number}","milestones_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/milestones{/number}","notifications_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/labels{/name}","releases_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/releases{/id}","deployments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/deployments","created_at":"2015-02-03T14:37:16Z","updated_at":"2016-03-03T20:16:57Z","pushed_at":"2016-06-13T16:43:41Z","git_url":"git://github.com/Metaswitch/clearwater-readthedocs.git","ssh_url":"git@github.com:Metaswitch/clearwater-readthedocs.git","clone_url":"https://github.com/Metaswitch/clearwater-readthedocs.git","svn_url":"https://github.com/Metaswitch/clearwater-readthedocs","homepage":null,"size":1340,"stargazers_count":0,"watchers_count":0,"language":"Makefile","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"open_issues_count":8,"forks":3,"open_issues":8,"watchers":0,"default_branch":"master"}},"base":{"label":"Metaswitch:master","ref":"master","sha":"3e8b85c014d46fcec5f859a8cbf83ed650f1e688","user":{"login":"Metaswitch","id":453759,"avatar_url":"https://avatars.githubusercontent.com/u/453759?v=3","gravatar_id":"","url":"https://api.github.com/users/Metaswitch","html_url":"https://github.com/Metaswitch","followers_url":"https://api.github.com/users/Metaswitch/followers","following_url":"https://api.github.com/users/Metaswitch/following{/other_user}","gists_url":"https://api.github.com/users/Metaswitch/gists{/gist_id}","starred_url":"https://api.github.com/users/Metaswitch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Metaswitch/subscriptions","organizations_url":"https://api.github.com/users/Metaswitch/orgs","repos_url":"https://api.github.com/users/Metaswitch/repos","events_url":"https://api.github.com/users/Metaswitch/events{/privacy}","received_events_url":"https://api.github.com/users/Metaswitch/received_events","type":"Organization","site_admin":false},"repo":{"id":30247023,"name":"clearwater-readthedocs","full_name":"Metaswitch/clearwater-readthedocs","owner":{"login":"Metaswitch","id":453759,"avatar_url":"https://avatars.githubusercontent.com/u/453759?v=3","gravatar_id":"","url":"https://api.github.com/users/Metaswitch","html_url":"https://github.com/Metaswitch","followers_url":"https://api.github.com/users/Metaswitch/followers","following_url":"https://api.github.com/users/Metaswitch/following{/other_user}","gists_url":"https://api.github.com/users/Metaswitch/gists{/gist_id}","starred_url":"https://api.github.com/users/Metaswitch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Metaswitch/subscriptions","organizations_url":"https://api.github.com/users/Metaswitch/orgs","repos_url":"https://api.github.com/users/Metaswitch/repos","events_url":"https://api.github.com/users/Metaswitch/events{/privacy}","received_events_url":"https://api.github.com/users/Metaswitch/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Metaswitch/clearwater-readthedocs","description":"Source repository for Clearwater's ReadTheDocs.org documentation","fork":false,"url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs","forks_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/forks","keys_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/teams","hooks_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/hooks","issue_events_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/events{/number}","events_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/events","assignees_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/assignees{/user}","branches_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/branches{/branch}","tags_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/tags","blobs_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/refs{/sha}","trees_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/statuses/{sha}","languages_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/languages","stargazers_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/stargazers","contributors_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/contributors","subscribers_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/subscribers","subscription_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/subscription","commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/commits{/sha}","git_commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/commits{/sha}","comments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/comments{/number}","issue_comment_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/comments{/number}","contents_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/contents/{+path}","compare_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/merges","archive_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/downloads","issues_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues{/number}","pulls_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls{/number}","milestones_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/milestones{/number}","notifications_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/labels{/name}","releases_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/releases{/id}","deployments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/deployments","created_at":"2015-02-03T14:37:16Z","updated_at":"2016-03-03T20:16:57Z","pushed_at":"2016-06-13T16:43:41Z","git_url":"git://github.com/Metaswitch/clearwater-readthedocs.git","ssh_url":"git@github.com:Metaswitch/clearwater-readthedocs.git","clone_url":"https://github.com/Metaswitch/clearwater-readthedocs.git","svn_url":"https://github.com/Metaswitch/clearwater-readthedocs","homepage":null,"size":1340,"stargazers_count":0,"watchers_count":0,"language":"Makefile","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"open_issues_count":8,"forks":3,"open_issues":8,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/185"},"html":{"href":"https://github.com/Metaswitch/clearwater-readthedocs/pull/185"},"issue":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/185"},"comments":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/185/comments"},"review_comments":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/185/comments"},"review_comment":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/185/commits"},"statuses":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/statuses/706f7c1a49b22d74f1648f1e72becd46ee14a050"}}}}
{"actor":{"display_login":"johadalin"}}