{"action":"created","comment":{"url":"https://api.github.com/repos/metomi/rose/pulls/comments/191849441","pull_request_review_id":124500534,"id":191849441,"diff_hunk":"@@ -0,0 +1,108 @@\n+.. include:: hyperlinks.rst\n+   :start-line: 1\n+\n+\n+Getting Started\n+===============\n+\n+If you are working with a new installation of rose you should look at the\n+:ref:`Site And User Configuration`.\n+\n+Rose combines the settings in the site configuration and the user configuration\n+at run time. You can view the resultant configuration by issuing the command::\n+\n+   rose config\n+\n+Rose should work out of the box if it is configured correctly at your site.\n+\n+\n+Text Editor\n+-----------\n+\n+* The default external text editor used by *GUIs* is ``gedit``.\n+* The default external text editor used by *CLI* commands is the value of\n+  the ``VISUAL`` or ``EDITOR`` environment variable, or ``vi`` if neither\n+  environment variable is set.\n+\n+To change the default editor change the following settings in the user\n+configuration file ``~/.metomi/rose.conf``:\n+\n+``[external]geditor``\n+   The external text editor used by GUIs\n+``[external]editor`` \n+   The external text editor used by CLI commands\n+\n+For emacs and most text editors, you can do something like:\n+\n+.. code-block:: rose\n+\n+   [external]\n+   editor=emacs\n+   geditor=emacs\n+\n+For any text editor command that normally forks and detaches from the shell\n+it is started it, you should use an option to ensure that the text editor\n+runs in the foreground to allow Rose to wait for the edit session to\n+finish. E.g. for ``gvim``, you will do:\n+\n+.. code-block:: rose\n+\n+   [external]\n+   editor=gvim -f\n+   geditor=gvim -f\n+\n+\n+Editor Syntax Highlighting\n+--------------------------\n+\n+There are ``gedit``, ``kate``, ``vim``, and ``emacs`` plugins for syntax\n+highlighting of Rose configuration files, located within the rose installation:\n+\n+* ``etc/rose-conf.lang``\n+* ``etc/rose-conf.xml``\n+* ``etc/rose-conf.vim``\n+* ``etc/rose-conf-mode.el``\n+\n+The plugins contain setup instructions within.\n+\n+.. _Pygments: http://pygments.org\n+\n+Additionally there is a `Pygments`_ lexer located in\n+``sphinx/ext/rose_lang.py``.\n+\n+.. hint::\n+\n+   You can locate your rose installation using::\n+\n+      rose version --long\n+\n+\n+Bash Auto-Completion\n+--------------------\n+\n+There is a Rose bash completion script that you can source to enhance the\n+Rose command line interface within an interactive Bash shell.\n+\n+The script allows you to tab-complete Rose commands, options, and arguments.\n+\n+You can find the script in the rose installation ``etc/rose-bash-completion``.\n+The file contains the instructions for using it.","path":"sphinx/getting-started.rst","position":89,"original_position":89,"commit_id":"ce1af4e6ab0c9b78e23a5d5e273aee4e1abcef46","original_commit_id":"ce1af4e6ab0c9b78e23a5d5e273aee4e1abcef46","user":{"login":"sadielbartholomew","id":30274190,"avatar_url":"https://avatars2.githubusercontent.com/u/30274190?v=4","gravatar_id":"","url":"https://api.github.com/users/sadielbartholomew","html_url":"https://github.com/sadielbartholomew","followers_url":"https://api.github.com/users/sadielbartholomew/followers","following_url":"https://api.github.com/users/sadielbartholomew/following{/other_user}","gists_url":"https://api.github.com/users/sadielbartholomew/gists{/gist_id}","starred_url":"https://api.github.com/users/sadielbartholomew/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sadielbartholomew/subscriptions","organizations_url":"https://api.github.com/users/sadielbartholomew/orgs","repos_url":"https://api.github.com/users/sadielbartholomew/repos","events_url":"https://api.github.com/users/sadielbartholomew/events{/privacy}","received_events_url":"https://api.github.com/users/sadielbartholomew/received_events","type":"User","site_admin":false},"body":"Perhaps to be completely clear mention that the instructions are brief/crude and in the header of the file.","created_at":"2018-05-30T17:12:42Z","updated_at":"2018-05-30T17:40:31Z","html_url":"https://github.com/metomi/rose/pull/2193#discussion_r191849441","pull_request_url":"https://api.github.com/repos/metomi/rose/pulls/2193","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/metomi/rose/pulls/comments/191849441"},"html":{"href":"https://github.com/metomi/rose/pull/2193#discussion_r191849441"},"pull_request":{"href":"https://api.github.com/repos/metomi/rose/pulls/2193"}}},"pull_request":{"url":"https://api.github.com/repos/metomi/rose/pulls/2193","id":191506098,"html_url":"https://github.com/metomi/rose/pull/2193","diff_url":"https://github.com/metomi/rose/pull/2193.diff","patch_url":"https://github.com/metomi/rose/pull/2193.patch","issue_url":"https://api.github.com/repos/metomi/rose/issues/2193","number":2193,"state":"open","locked":false,"title":"doc: getting started","user":{"login":"oliver-sanders","id":16705946,"avatar_url":"https://avatars0.githubusercontent.com/u/16705946?v=4","gravatar_id":"","url":"https://api.github.com/users/oliver-sanders","html_url":"https://github.com/oliver-sanders","followers_url":"https://api.github.com/users/oliver-sanders/followers","following_url":"https://api.github.com/users/oliver-sanders/following{/other_user}","gists_url":"https://api.github.com/users/oliver-sanders/gists{/gist_id}","starred_url":"https://api.github.com/users/oliver-sanders/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oliver-sanders/subscriptions","organizations_url":"https://api.github.com/users/oliver-sanders/orgs","repos_url":"https://api.github.com/users/oliver-sanders/repos","events_url":"https://api.github.com/users/oliver-sanders/events{/privacy}","received_events_url":"https://api.github.com/users/oliver-sanders/received_events","type":"User","site_admin":false},"body":"Add missing \"getting started\", translated from the old documentation with a few small changes.","created_at":"2018-05-30T16:09:24Z","updated_at":"2018-05-30T17:40:31Z","closed_at":null,"merged_at":null,"merge_commit_sha":"08997cbbd7427a07d94459c4ebe8416224161890","assignee":{"login":"oliver-sanders","id":16705946,"avatar_url":"https://avatars0.githubusercontent.com/u/16705946?v=4","gravatar_id":"","url":"https://api.github.com/users/oliver-sanders","html_url":"https://github.com/oliver-sanders","followers_url":"https://api.github.com/users/oliver-sanders/followers","following_url":"https://api.github.com/users/oliver-sanders/following{/other_user}","gists_url":"https://api.github.com/users/oliver-sanders/gists{/gist_id}","starred_url":"https://api.github.com/users/oliver-sanders/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oliver-sanders/subscriptions","organizations_url":"https://api.github.com/users/oliver-sanders/orgs","repos_url":"https://api.github.com/users/oliver-sanders/repos","events_url":"https://api.github.com/users/oliver-sanders/events{/privacy}","received_events_url":"https://api.github.com/users/oliver-sanders/received_events","type":"User","site_admin":false},"assignees":[{"login":"oliver-sanders","id":16705946,"avatar_url":"https://avatars0.githubusercontent.com/u/16705946?v=4","gravatar_id":"","url":"https://api.github.com/users/oliver-sanders","html_url":"https://github.com/oliver-sanders","followers_url":"https://api.github.com/users/oliver-sanders/followers","following_url":"https://api.github.com/users/oliver-sanders/following{/other_user}","gists_url":"https://api.github.com/users/oliver-sanders/gists{/gist_id}","starred_url":"https://api.github.com/users/oliver-sanders/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oliver-sanders/subscriptions","organizations_url":"https://api.github.com/users/oliver-sanders/orgs","repos_url":"https://api.github.com/users/oliver-sanders/repos","events_url":"https://api.github.com/users/oliver-sanders/events{/privacy}","received_events_url":"https://api.github.com/users/oliver-sanders/received_events","type":"User","site_admin":false}],"requested_reviewers":[{"login":"matthewrmshin","id":908613,"avatar_url":"https://avatars3.githubusercontent.com/u/908613?v=4","gravatar_id":"","url":"https://api.github.com/users/matthewrmshin","html_url":"https://github.com/matthewrmshin","followers_url":"https://api.github.com/users/matthewrmshin/followers","following_url":"https://api.github.com/users/matthewrmshin/following{/other_user}","gists_url":"https://api.github.com/users/matthewrmshin/gists{/gist_id}","starred_url":"https://api.github.com/users/matthewrmshin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/matthewrmshin/subscriptions","organizations_url":"https://api.github.com/users/matthewrmshin/orgs","repos_url":"https://api.github.com/users/matthewrmshin/repos","events_url":"https://api.github.com/users/matthewrmshin/events{/privacy}","received_events_url":"https://api.github.com/users/matthewrmshin/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[],"milestone":{"url":"https://api.github.com/repos/metomi/rose/milestones/60","html_url":"https://github.com/metomi/rose/milestone/60","labels_url":"https://api.github.com/repos/metomi/rose/milestones/60/labels","id":3365198,"number":60,"title":"next-release","description":"Rose release 55.","creator":{"login":"matthewrmshin","id":908613,"avatar_url":"https://avatars3.githubusercontent.com/u/908613?v=4","gravatar_id":"","url":"https://api.github.com/users/matthewrmshin","html_url":"https://github.com/matthewrmshin","followers_url":"https://api.github.com/users/matthewrmshin/followers","following_url":"https://api.github.com/users/matthewrmshin/following{/other_user}","gists_url":"https://api.github.com/users/matthewrmshin/gists{/gist_id}","starred_url":"https://api.github.com/users/matthewrmshin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/matthewrmshin/subscriptions","organizations_url":"https://api.github.com/users/matthewrmshin/orgs","repos_url":"https://api.github.com/users/matthewrmshin/repos","events_url":"https://api.github.com/users/matthewrmshin/events{/privacy}","received_events_url":"https://api.github.com/users/matthewrmshin/received_events","type":"User","site_admin":false},"open_issues":2,"closed_issues":2,"state":"open","created_at":"2018-05-22T15:11:08Z","updated_at":"2018-05-30T16:09:24Z","due_on":"2018-06-30T07:00:00Z","closed_at":null},"commits_url":"https://api.github.com/repos/metomi/rose/pulls/2193/commits","review_comments_url":"https://api.github.com/repos/metomi/rose/pulls/2193/comments","review_comment_url":"https://api.github.com/repos/metomi/rose/pulls/comments{/number}","comments_url":"https://api.github.com/repos/metomi/rose/issues/2193/comments","statuses_url":"https://api.github.com/repos/metomi/rose/statuses/ce1af4e6ab0c9b78e23a5d5e273aee4e1abcef46","head":{"label":"oliver-sanders:rose-user-guide-getting-started","ref":"rose-user-guide-getting-started","sha":"ce1af4e6ab0c9b78e23a5d5e273aee4e1abcef46","user":{"login":"oliver-sanders","id":16705946,"avatar_url":"https://avatars0.githubusercontent.com/u/16705946?v=4","gravatar_id":"","url":"https://api.github.com/users/oliver-sanders","html_url":"https://github.com/oliver-sanders","followers_url":"https://api.github.com/users/oliver-sanders/followers","following_url":"https://api.github.com/users/oliver-sanders/following{/other_user}","gists_url":"https://api.github.com/users/oliver-sanders/gists{/gist_id}","starred_url":"https://api.github.com/users/oliver-sanders/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oliver-sanders/subscriptions","organizations_url":"https://api.github.com/users/oliver-sanders/orgs","repos_url":"https://api.github.com/users/oliver-sanders/repos","events_url":"https://api.github.com/users/oliver-sanders/events{/privacy}","received_events_url":"https://api.github.com/users/oliver-sanders/received_events","type":"User","site_admin":false},"repo":{"id":49660258,"name":"rose","full_name":"oliver-sanders/rose","owner":{"login":"oliver-sanders","id":16705946,"avatar_url":"https://avatars0.githubusercontent.com/u/16705946?v=4","gravatar_id":"","url":"https://api.github.com/users/oliver-sanders","html_url":"https://github.com/oliver-sanders","followers_url":"https://api.github.com/users/oliver-sanders/followers","following_url":"https://api.github.com/users/oliver-sanders/following{/other_user}","gists_url":"https://api.github.com/users/oliver-sanders/gists{/gist_id}","starred_url":"https://api.github.com/users/oliver-sanders/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oliver-sanders/subscriptions","organizations_url":"https://api.github.com/users/oliver-sanders/orgs","repos_url":"https://api.github.com/users/oliver-sanders/repos","events_url":"https://api.github.com/users/oliver-sanders/events{/privacy}","received_events_url":"https://api.github.com/users/oliver-sanders/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/oliver-sanders/rose","description":"Rose: a framework for managing and running meteorological suites.","fork":true,"url":"https://api.github.com/repos/oliver-sanders/rose","forks_url":"https://api.github.com/repos/oliver-sanders/rose/forks","keys_url":"https://api.github.com/repos/oliver-sanders/rose/keys{/key_id}","collaborators_url":"https://api.github.com/repos/oliver-sanders/rose/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/oliver-sanders/rose/teams","hooks_url":"https://api.github.com/repos/oliver-sanders/rose/hooks","issue_events_url":"https://api.github.com/repos/oliver-sanders/rose/issues/events{/number}","events_url":"https://api.github.com/repos/oliver-sanders/rose/events","assignees_url":"https://api.github.com/repos/oliver-sanders/rose/assignees{/user}","branches_url":"https://api.github.com/repos/oliver-sanders/rose/branches{/branch}","tags_url":"https://api.github.com/repos/oliver-sanders/rose/tags","blobs_url":"https://api.github.com/repos/oliver-sanders/rose/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/oliver-sanders/rose/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/oliver-sanders/rose/git/refs{/sha}","trees_url":"https://api.github.com/repos/oliver-sanders/rose/git/trees{/sha}","statuses_url":"https://api.github.com/repos/oliver-sanders/rose/statuses/{sha}","languages_url":"https://api.github.com/repos/oliver-sanders/rose/languages","stargazers_url":"https://api.github.com/repos/oliver-sanders/rose/stargazers","contributors_url":"https://api.github.com/repos/oliver-sanders/rose/contributors","subscribers_url":"https://api.github.com/repos/oliver-sanders/rose/subscribers","subscription_url":"https://api.github.com/repos/oliver-sanders/rose/subscription","commits_url":"https://api.github.com/repos/oliver-sanders/rose/commits{/sha}","git_commits_url":"https://api.github.com/repos/oliver-sanders/rose/git/commits{/sha}","comments_url":"https://api.github.com/repos/oliver-sanders/rose/comments{/number}","issue_comment_url":"https://api.github.com/repos/oliver-sanders/rose/issues/comments{/number}","contents_url":"https://api.github.com/repos/oliver-sanders/rose/contents/{+path}","compare_url":"https://api.github.com/repos/oliver-sanders/rose/compare/{base}...{head}","merges_url":"https://api.github.com/repos/oliver-sanders/rose/merges","archive_url":"https://api.github.com/repos/oliver-sanders/rose/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/oliver-sanders/rose/downloads","issues_url":"https://api.github.com/repos/oliver-sanders/rose/issues{/number}","pulls_url":"https://api.github.com/repos/oliver-sanders/rose/pulls{/number}","milestones_url":"https://api.github.com/repos/oliver-sanders/rose/milestones{/number}","notifications_url":"https://api.github.com/repos/oliver-sanders/rose/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/oliver-sanders/rose/labels{/name}","releases_url":"https://api.github.com/repos/oliver-sanders/rose/releases{/id}","deployments_url":"https://api.github.com/repos/oliver-sanders/rose/deployments","created_at":"2016-01-14T16:38:12Z","updated_at":"2018-05-30T09:45:53Z","pushed_at":"2018-05-30T16:07:40Z","git_url":"git://github.com/oliver-sanders/rose.git","ssh_url":"git@github.com:oliver-sanders/rose.git","clone_url":"https://github.com/oliver-sanders/rose.git","svn_url":"https://github.com/oliver-sanders/rose","homepage":"metomi.github.io/rose/doc/","size":22991,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"gpl-3.0","name":"GNU General Public License v3.0","spdx_id":"GPL-3.0","url":"https://api.github.com/licenses/gpl-3.0"},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"metomi:master","ref":"master","sha":"ad6bdf08a99a3935094d52f3d14d66070d1bb4b8","user":{"login":"metomi","id":2477494,"avatar_url":"https://avatars3.githubusercontent.com/u/2477494?v=4","gravatar_id":"","url":"https://api.github.com/users/metomi","html_url":"https://github.com/metomi","followers_url":"https://api.github.com/users/metomi/followers","following_url":"https://api.github.com/users/metomi/following{/other_user}","gists_url":"https://api.github.com/users/metomi/gists{/gist_id}","starred_url":"https://api.github.com/users/metomi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/metomi/subscriptions","organizations_url":"https://api.github.com/users/metomi/orgs","repos_url":"https://api.github.com/users/metomi/repos","events_url":"https://api.github.com/users/metomi/events{/privacy}","received_events_url":"https://api.github.com/users/metomi/received_events","type":"Organization","site_admin":false},"repo":{"id":6223866,"name":"rose","full_name":"metomi/rose","owner":{"login":"metomi","id":2477494,"avatar_url":"https://avatars3.githubusercontent.com/u/2477494?v=4","gravatar_id":"","url":"https://api.github.com/users/metomi","html_url":"https://github.com/metomi","followers_url":"https://api.github.com/users/metomi/followers","following_url":"https://api.github.com/users/metomi/following{/other_user}","gists_url":"https://api.github.com/users/metomi/gists{/gist_id}","starred_url":"https://api.github.com/users/metomi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/metomi/subscriptions","organizations_url":"https://api.github.com/users/metomi/orgs","repos_url":"https://api.github.com/users/metomi/repos","events_url":"https://api.github.com/users/metomi/events{/privacy}","received_events_url":"https://api.github.com/users/metomi/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/metomi/rose","description":":rose: Rose: a framework for managing and running meteorological suites.","fork":false,"url":"https://api.github.com/repos/metomi/rose","forks_url":"https://api.github.com/repos/metomi/rose/forks","keys_url":"https://api.github.com/repos/metomi/rose/keys{/key_id}","collaborators_url":"https://api.github.com/repos/metomi/rose/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/metomi/rose/teams","hooks_url":"https://api.github.com/repos/metomi/rose/hooks","issue_events_url":"https://api.github.com/repos/metomi/rose/issues/events{/number}","events_url":"https://api.github.com/repos/metomi/rose/events","assignees_url":"https://api.github.com/repos/metomi/rose/assignees{/user}","branches_url":"https://api.github.com/repos/metomi/rose/branches{/branch}","tags_url":"https://api.github.com/repos/metomi/rose/tags","blobs_url":"https://api.github.com/repos/metomi/rose/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/metomi/rose/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/metomi/rose/git/refs{/sha}","trees_url":"https://api.github.com/repos/metomi/rose/git/trees{/sha}","statuses_url":"https://api.github.com/repos/metomi/rose/statuses/{sha}","languages_url":"https://api.github.com/repos/metomi/rose/languages","stargazers_url":"https://api.github.com/repos/metomi/rose/stargazers","contributors_url":"https://api.github.com/repos/metomi/rose/contributors","subscribers_url":"https://api.github.com/repos/metomi/rose/subscribers","subscription_url":"https://api.github.com/repos/metomi/rose/subscription","commits_url":"https://api.github.com/repos/metomi/rose/commits{/sha}","git_commits_url":"https://api.github.com/repos/metomi/rose/git/commits{/sha}","comments_url":"https://api.github.com/repos/metomi/rose/comments{/number}","issue_comment_url":"https://api.github.com/repos/metomi/rose/issues/comments{/number}","contents_url":"https://api.github.com/repos/metomi/rose/contents/{+path}","compare_url":"https://api.github.com/repos/metomi/rose/compare/{base}...{head}","merges_url":"https://api.github.com/repos/metomi/rose/merges","archive_url":"https://api.github.com/repos/metomi/rose/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/metomi/rose/downloads","issues_url":"https://api.github.com/repos/metomi/rose/issues{/number}","pulls_url":"https://api.github.com/repos/metomi/rose/pulls{/number}","milestones_url":"https://api.github.com/repos/metomi/rose/milestones{/number}","notifications_url":"https://api.github.com/repos/metomi/rose/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/metomi/rose/labels{/name}","releases_url":"https://api.github.com/repos/metomi/rose/releases{/id}","deployments_url":"https://api.github.com/repos/metomi/rose/deployments","created_at":"2012-10-15T08:31:10Z","updated_at":"2018-05-30T07:12:37Z","pushed_at":"2018-05-30T16:09:25Z","git_url":"git://github.com/metomi/rose.git","ssh_url":"git@github.com:metomi/rose.git","clone_url":"https://github.com/metomi/rose.git","svn_url":"https://github.com/metomi/rose","homepage":"https://metomi.github.io/rose/","size":23102,"stargazers_count":35,"watchers_count":35,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":32,"mirror_url":null,"archived":false,"open_issues_count":98,"license":{"key":"gpl-3.0","name":"GNU General Public License v3.0","spdx_id":"GPL-3.0","url":"https://api.github.com/licenses/gpl-3.0"},"forks":32,"open_issues":98,"watchers":35,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/metomi/rose/pulls/2193"},"html":{"href":"https://github.com/metomi/rose/pull/2193"},"issue":{"href":"https://api.github.com/repos/metomi/rose/issues/2193"},"comments":{"href":"https://api.github.com/repos/metomi/rose/issues/2193/comments"},"review_comments":{"href":"https://api.github.com/repos/metomi/rose/pulls/2193/comments"},"review_comment":{"href":"https://api.github.com/repos/metomi/rose/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/metomi/rose/pulls/2193/commits"},"statuses":{"href":"https://api.github.com/repos/metomi/rose/statuses/ce1af4e6ab0c9b78e23a5d5e273aee4e1abcef46"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"sadielbartholomew"}}