Nicola Larosa has proposed merging lp:~teknico/juju-gui/do-the-readmemotion into lp:juju-gui.
Requested reviews: Juju GUI Hackers (juju-gui) For more details, see: https://code.launchpad.net/~teknico/juju-gui/do-the-readmemotion/+merge/131859 Reformat the README file. Reformat the README file as proper ReST markup, so that my head does not hurt every time I read it. With a few spelling and style fixes. https://codereview.appspot.com/6814049/ -- https://code.launchpad.net/~teknico/juju-gui/do-the-readmemotion/+merge/131859 Your team Juju GUI Hackers is requested to review the proposed merge of lp:~teknico/juju-gui/do-the-readmemotion into lp:juju-gui.
=== modified file 'README' --- README 2012-10-26 15:27:45 +0000 +++ README 2012-10-29 11:02:29 +0000 @@ -1,92 +1,86 @@ Developer Install ------------------ - - Juju GUI uses nodejs based development tools. - - You'll need nodejs & npm from the ppa:: - -sudo add-apt-repository ppa:chris-lea/node.js -sudo apt-get update -sudo apt-get install nodejs npm - - The linter will be installed locally per branch, but if you want editor - integration, you may want to install jshint globally in your system. - -sudo npm install -g jshint - - For building the docs, you also need sphinx. - -sudo apt-get install python-sphinx - - The gui frontend can be installed with:: - -bzr branch lp:juju-ui trunk -cd trunk -make server - - - 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 utilize as a server is - ``lp:~hazmat/juju/rapi-delta``. - - - You can utilize it with any environment, but for dev purposes, a - local environment works well. One environment option specific to this - branch is the api-port. A sample configuration appropriate:: - -default: dev -environments: - dev: - type: local - data-dir: /home/kapil/.juju/local - admin-secret: b3a5dee4fb8c4fc9a4db04751e5936f4 - default-series: precise - juju-origin: ppa - api-port: 8081 - - Note juju-origin is set to the ppa, the api server runs outside of - the container, and is launched using whichever branch your using. - - Also note the api-port should be spec'd at 8081, which the gui's - initial environment connection currently defaults to. - - You'll need to bootstrap the local environment, and deploy one - service. The api server needs access to the provisioning credentials - which are lazy initialized in juju upon usage. - - After which the gui should be functional (it automatically polls the - api server for establishing a websocket). - - -Running unit tests. -------------------- - - xdg-open test/index.html - +================= + +Juju GUI uses nodejs based development tools. + +You'll need nodejs & npm from the ppa:: + + $ sudo add-apt-repository ppa:chris-lea/node.js + $ sudo apt-get update + $ sudo apt-get install nodejs npm + +The linter will be installed locally per branch, but if you want editor +integration, you may want to install jshint globally in your system:: + + $ sudo npm install -g jshint + +For building the docs, you also need sphinx:: + + $ sudo apt-get install python-sphinx + +The gui frontend can be installed with:: + + $ bzr branch lp:juju-ui trunk + $ cd trunk + $ make server + +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-delta``. + +You can use it with any environment, but for dev purposes, a local +environment works well. One environment option specific to this branch +is the api-port. An appropriate sample configuration:: + + default: dev + environments: + dev: + type: local + data-dir: /home/kapil/.juju/local + admin-secret: b3a5dee4fb8c4fc9a4db04751e5936f4 + default-series: precise + juju-origin: ppa + api-port: 8081 + +Note that juju-origin is set to the ppa, the api server runs outside of +the container, and is launched using whichever branch you're using. + +Also note that the api-port should be set at 8081, which the gui's +initial environment connection currently defaults to. + +You'll need to bootstrap the local environment, and deploy one service. +The api server needs access to the provisioning credentials which are +lazily initialized in juju upon usage. + +After which, the gui should be functional (it automatically polls the +api server for establishing a websocket). + +Running unit tests +================== + + $ xdg-open test/index.html Documentation -------------- - -Generated JavaScript documentation is available in the yuidoc directory. Start -with the index.html file. You can view the docs by running this command:: - - xdg-open yuidoc/index.html - -To regenerate the docs run this command:: - - make yuidoc - -The documentation for yuidoc markup is at http://yui.github.com/yuidoc/syntax/. - +============= + +Generated JavaScript documentation is available in the yuidoc directory. +Start with the index.html file. You can view the docs by running:: + + $ xdg-open yuidoc/index.html + +To regenerate the docs run:: + + $ make yuidoc + +The documentation for yuidoc markup is at +http://yui.github.com/yuidoc/syntax/ . Running lint ------------- - - jshint --config=jshint.config `bzr ls -RV -k file | grep -v assets/` - +============ + + $ jshint --config=jshint.config `bzr ls -RV -k file | grep -v assets/` Style ------ +===== -See the docs/style-guide.rst file for the project style guide. +See the ``docs/style-guide.rst`` file for the project style guide.
-- Mailing list: https://launchpad.net/~yellow Post to : [email protected] Unsubscribe : https://launchpad.net/~yellow More help : https://help.launchpad.net/ListHelp
