yellow team mailing list archive

[Brad Crittenden <bac@xxxxxxxxxxxxx>]

Reviewers: mp+141747_code.launchpad.net,

Message:
Please take a look.

Description:
Update HACKING to reflect current state.

The HACKING document was out-of-date regarding dependencies, required
steps,
etc.  Following the instructions on a newly installed, non-developer
machine
showed the places where packages were missing.

https://code.launchpad.net/~bac/juju-gui/hacking/+merge/141747

(do not edit description out of merge proposal)


Please review this at https://codereview.appspot.com/7030056/

Affected files:
   M HACKING
   A [revision details]


Index: HACKING
=== modified file 'HACKING'
--- HACKING	2012-12-18 20:31:15 +0000
+++ HACKING	2013-01-03 12:53:38 +0000
@@ -32,11 +32,11 @@

    $ sudo apt-get install python-tz

-The gui frontend can be installed with::
+The gui frontend can be installed and run with::

    $ bzr branch lp:juju-gui trunk
    $ cd trunk
-  $ make server
+  $ make prod

  It may take a while for the server to start the first time as npm will
  need to download packages.  When ready, the server will print:
@@ -45,9 +45,17 @@

  You can then access the GUI at <http://localhost:8888/>.

-You'll also need to deploy a juju environment with REST api access.
+The front-end needs to talk to a Juju backend.  So first you'll need
+to install Juju::
+
+   $ sudo apt-get install juju zookeeper
+
+Next you'll also need to deploy a juju environment with REST api access.
  Currently that work resides in a pipeline of juju branches. The
-recommended branch to use as a server is ``lp:~hazmat/juju/rapi-rollup``.
+recommended branch to use as a server is
+``lp:~hazmat/juju/rapi-rollup``::
+
+   $ bzr branch lp:~hazmat/juju/rapi-rollup

  You can use it with any environment, but for dev purposes, a local
  environment works well. One environment option specific to this branch
@@ -63,6 +71,7 @@
        juju-origin: ppa
        api-port: 8081

+
  Note that juju-origin is set to the ppa, the api server runs outside of
  the container, and it is launched using whichever branch you're using.

@@ -97,19 +106,21 @@
  Running Unit Tests
  ==================

-  $ make test
+  $ make test-prod

  Running Lint
  ============

+  $ sudo apt-get install python-virtualenv
    $ make lint

  API Documentation
  =================

-Generated JavaScript documentation is available in the yuidoc directory  
after
-running the command ``make yuidoc``. You can view the docs by running::
+Generated JavaScript documentation is available in the yuidoc
+directory.  You can view the docs by running::

+  $ make yuidoc
    $ xdg-open yuidoc/index.html

  The `documentation <http://yui.github.com/yuidoc/syntax/>`_ for YUIDoc  
markup
@@ -125,7 +136,7 @@

  Build the documentation::

-  $ make doc
+  $ make docs

  (This will also generate the above mentioned yuidoc documentation.)



Index: [revision details]
=== added file '[revision details]'
--- [revision details]	2012-01-01 00:00:00 +0000
+++ [revision details]	2012-01-01 00:00:00 +0000
@@ -0,0 +1,2 @@
+Old revision: bac@xxxxxxxxxxxxx-20130102130815-4e28oux8pq5oizvk
+New revision: bac@xxxxxxxxxxxxx-20130103125338-5l4ey64j0kibjfgh




-- 
https://code.launchpad.net/~bac/juju-gui/hacking/+merge/141747
Your team Juju GUI Hackers is requested to review the proposed merge of lp:~bac/juju-gui/hacking into lp:juju-gui.