Merge lp:~hatch/juju-gui/1123291-update-hacking into lp:juju-gui/experimental

[Jeff Pihach]

Added missing PPA's and packages

https://codereview.appspot.com/7322056/

[Jeff Pihach (hatch)]

Reviewers: mp+148016_code.launchpad.net,

Message:
Please take a look.

Description:
Added missing PPA's and packages

https://code.launchpad.net/~hatch/juju-gui/1123291-update-hacking/+merge/148016

(do not edit description out of merge proposal)

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

Affected files:
   M HACKING
   A [revision details]

Index: HACKING
=== modified file 'HACKING'
--- HACKING 2013-01-30 17:48:54 +0000
+++ HACKING 2013-02-12 18:03:33 +0000
@@ -49,8 +49,10 @@
  locally::

    sudo add-apt-repository ppa:chris-lea/node.js
+ sudo add-apt-repository ppa:gophers/go
+ sudo add-apt-repository ppa:juju/pkgs
    sudo apt-get update
- sudo apt-get install nodejs npm imagemagick lbox python-sphinx
python-yaml python-tz python-virtualenv
+ sudo apt-get install nodejs npm imagemagick lbox python-sphinx
python-yaml python-tz python-virtualenv python-shelltoolbox

  The jshint linter will be installed locally per branch, but if you want
editor
  integration, you may want to install ``jshint`` globally in your system.
More

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: <email address hidden>
+New revision: <email address hidden>

[Brad Crittenden (bac)]

Thanks for the changes Jeff. You can land as is or make the change I
ask about. It would be nice to have but it's up to you.

https://codereview.appspot.com/7322056/diff/1/HACKING
File HACKING (right):

https://codereview.appspot.com/7322056/diff/1/HACKING#newcode52
HACKING:52: sudo add-apt-repository ppa:gophers/go
I wonder if we should actually mention lbox here or perhaps later in a
new section about contributing code?

https://codereview.appspot.com/7322056/

[Gary Poster (gary)]

Land with changes.

I'm asking you for a few more fly-bys from what I noticed of your
adventures. Thanks!

Gary

https://codereview.appspot.com/7322056/diff/1/HACKING
File HACKING (right):

https://codereview.appspot.com/7322056/diff/1/HACKING#newcode14
HACKING:14: Before you get the GUI, first you need to get Juju. For
PyJuju, the original
Add:

...first you need to get Juju. We use the fresh one from the Juju PPA.
For PyJuju...

https://codereview.appspot.com/7322056/diff/1/HACKING#newcode15
HACKING:15: Python-based implementation, we use a custom branch of Juju
that supplies the
add "also":

...implementation, we also use...

https://codereview.appspot.com/7322056/diff/1/HACKING#newcode20
HACKING:20:
Add this here:

sudo add-apt-repository ppa:juju/pkgs

This will also be important for python-shelltoolbox if the dev is
running precise.

https://codereview.appspot.com/7322056/diff/1/HACKING#newcode49
HACKING:49: locally::
also add explanation "python-shelltoolbox and python-selenium for
browser tests, ..."

https://codereview.appspot.com/7322056/diff/1/HACKING#newcode52
HACKING:52: sudo add-apt-repository ppa:gophers/go
On 2013/02/12 21:40:56, bac wrote:
> I wonder if we should actually mention lbox here or perhaps later in a
new
> section about contributing code?

I like the simplicity of putting everything at the top. We explain it
in the text, for people who care.

https://codereview.appspot.com/7322056/diff/1/HACKING#newcode55
HACKING:55: sudo apt-get install nodejs npm imagemagick lbox
python-sphinx python-yaml python-tz python-virtualenv
python-shelltoolbox
add python-selenium please (see docs/browser-testing.rst if you are
curious about the source for these two deps)

https://codereview.appspot.com/7322056/

[lp:~hatch/juju-gui/1123291-update-hacking]

381. By Jeff Pihach on 2013-02-13

added in requested changes from review and added in section

[Jeff Pihach (hatch)]

Please take a look.

https://codereview.appspot.com/7322056/

[Madison Scott-Clary (makyo)]

Land with changes. Thanks, looks good.

https://codereview.appspot.com/7322056/diff/4001/HACKING
File HACKING (right):

https://codereview.appspot.com/7322056/diff/4001/HACKING#newcode96
HACKING:96: works well for our development
workflows. Here is a workflow that works well for our development.

https://codereview.appspot.com/7322056/diff/4001/HACKING#newcode98
HACKING:98: To set up the environment::
Commands below should be indented.

https://codereview.appspot.com/7322056/diff/4001/HACKING#newcode104
HACKING:104: bzr branch trunk/{featureBranchName}
bzr branch trunk yourUserName/{featureBranchName}

https://codereview.appspot.com/7322056/

[Jeff Pihach (hatch)]

Please take a look.

https://codereview.appspot.com/7322056/

[Gary Poster (gary)]

A few more suggestions.

Land with changes. (This means you I am saying you don't need to wait
for me to re-review, and I probably won't unless you ask me to
explicitly.)

Thanks

Gary

https://codereview.appspot.com/7322056/diff/7001/HACKING
File HACKING (right):

https://codereview.appspot.com/7322056/diff/7001/HACKING#newcode17
HACKING:17: will have a websocket API provided for us directly as part
of the software.)
Please get this <80 chars. Old fashioned, but it's habit and the rest
of the code base conforms to it wherever possible

https://codereview.appspot.com/7322056/diff/7001/HACKING#newcode59
HACKING:59: python-shelltoolbox and python-selenium
That comment was really for you, but if you like it go for it. If you
keep it, s/the source for/the reason for needing/

https://codereview.appspot.com/7322056/diff/7001/HACKING#newcode95
HACKING:95: Bazaar allows you to work in a lot of different workflows -
a workflow that
Bazaar allows you to work in a lot of different workflows. Here is one
that works well for our environment, if you are not already familiar
with bzr.

https://codereview.appspot.com/7322056/

[Jeff Pihach (hatch)]

*** Submitted:

Added missing PPA's and packages

R=bac, gary.poster, matthew.scott
CC=
https://codereview.appspot.com/7322056

https://codereview.appspot.com/7322056/

=== modified file 'HACKING'
--- HACKING	2013-01-30 17:48:54 +0000
+++ HACKING	2013-02-13 16:28:22 +0000
@@ -11,13 +11,15 @@
 Developer Install
 =================
 
-Before you get the GUI, first you need to get Juju.  For PyJuju, the original
-Python-based implementation, we use a custom branch of Juju that supplies the
-websocket API we need.  (GoJuju, the newer Go-based implementation, will have
-a websocket API provided for us directly as part of the software.)
+Before you get the GUI you need to get Juju. We use the fresh one from the Juju PPA.
+For PyJuju, the original Python-based implementation, we also use a custom branch of Juju
+that supplies the websocket API we need.  (GoJuju, the newer Go-based implementation,
+will have a websocket API provided for us directly as part of the software.)
 
 ::
 
+  sudo add-apt-repository ppa:juju/pkgs
+  sudo apt-get update
   sudo apt-get install juju zookeeper
 
 Next you will also need to get the Juju branch that has API access.
@@ -45,12 +47,16 @@
 based development tools, so you will need ``nodejs`` and ``npm`` from Chris
 Lea's node PPA. You also need ImageMagick for sprite generation, lbox to
 propose branches, python-sphinx and python-yaml to build docs, PyTZ to make
-releases, and python-virtualenv to build the Google Closure linter tools
-locally::
+releases, python-shelltoolbox and python-selenium for browser tests, and
+python-virtualenv to build the Google Closure linter tools locally::
 
   sudo add-apt-repository ppa:chris-lea/node.js
+  sudo add-apt-repository ppa:gophers/go
   sudo apt-get update
-  sudo apt-get install nodejs npm imagemagick lbox python-sphinx python-yaml python-tz python-virtualenv
+  sudo apt-get install nodejs npm imagemagick lbox python-sphinx python-yaml python-tz python-virtualenv python-shelltoolbox python-selenium
+
+See docs/browser-testing.rst if you are curious about the source for
+python-shelltoolbox and python-selenium
 
 The jshint linter will be installed locally per branch, but if you want editor
 integration, you may want to install ``jshint`` globally in your system.  More
@@ -83,6 +89,36 @@
 while using the PyJuju rapi-rollup improv script, the password you should use
 is "admin," despite the help text you see.
 
+Typical Bzr workflow
+=====================
+
+Bazaar allows you to work in a lot of different workflows - a workflow that
+works well for our development
+
+To set up the environment::
+
+bzr init-repo juju-gui
+cd juju-gui
+bzr branch lp:juju-gui trunk
+mkdir yourUseName
+bzr branch trunk/{featureBranchName}
+
+To link branch to ticket::
+
+bzr commit --fixes=lp:{ticketNumber}
+
+To push code::
+
+bzr push lp:~{yourUserName}/juju-gui/{featureBranchName}
+
+To submit for review::
+
+lbox propose -cr
+
+After review, to merge into trunk::
+
+lbox submit
+
 Working with a Real Juju
 ========================