From ecfe1f6d2594e408cda82888e233d31184e08c5c Mon Sep 17 00:00:00 2001 From: Ed Morley Date: Thu, 21 Aug 2014 15:59:27 +0100 Subject: [PATCH] Bug 1045090 - Fix docs to reflect dependency on ui repo in default configuration; r=mdoglio --- docs/installation.rst | 10 ++++++++-- docs/ui_integration.rst | 13 ++++++++----- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index a44d71739..3924a60d1 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,10 +1,16 @@ Installation ================ -* Clone the `project repo`_ on Github +* Clone the `treeherder-service repo`_ from Github. * Install Virtualbox_ and Vagrant_ if not present. +* Either follow the :doc:`ui_integration` steps, or comment out this line in the Vagrantfile: + + .. code-block:: ruby + + config.vm.synced_folder "../treeherder-ui", "/home/vagrant/treeherder-ui", type: "nfs" + * Open a shell, cd into the root of the project you just cloned and type .. code-block:: bash @@ -89,6 +95,6 @@ Installation -.. _project repo: https://github.com/mozilla/treeherder-service +.. _treeherder-service repo: https://github.com/mozilla/treeherder-service .. _Vagrant: https://www.vagrantup.com .. _Virtualbox: https://www.virtualbox.org diff --git a/docs/ui_integration.rst b/docs/ui_integration.rst index 622b61aac..95b09926a 100644 --- a/docs/ui_integration.rst +++ b/docs/ui_integration.rst @@ -2,16 +2,19 @@ Integrating the ui ================== If you want to develop both the ui and the service side by side it may be convenient to load the ui in the vagrant environment. -To do so, uncomment this line in the Vagrantfile - .. code-block:: ruby - - #config.vm.share_folder("treeherder-ui", "/home/vagrant/treeherder-ui", "../treeherder-ui/", :nfs => nfs) +* Make sure the `treeherder-ui repo`_ is cloned in the same parent folder as treeherder-service (and with the directory name 'treeherder-ui'). -Make sure treeherder-ui is cloned in the same folder as treeherder-service (same parent folder) and reload you vagrant environment with +* If you previously commented out the treeherder-ui line in the Vagrantfile as part of the :doc:`installation` instructions, undo that now. + +* If you have an existing Vagrant environment set up, you will need to reload it using: .. code-block:: bash >vagrant reload You should now be able to access the ui on http://local.treeherder.mozilla.org/ui/ + + + +.. _treeherder-ui repo: https://github.com/mozilla/treeherder-ui