Issue 6816114: Add README (Closed)
|
Created:
12 years, 4 months ago by dave Modified:
12 years, 4 months ago Reviewers:
mp+133857 Visibility:
Public. |
DescriptionAdd README
https://code.launchpad.net/~dave-cheney/juju-core/035-juju-README/+merge/133857
(do not edit description out of merge proposal)
Patch Set 1 #
Total comments: 19
Patch Set 2 : Add README #
Total comments: 10
Patch Set 3 : Add README #MessagesTotal messages: 10
Please take a look.
Sign in to reply to this message.
Essentially LGTM; really just suggestions. https://codereview.appspot.com/6816114/diff/1/README File README (right): https://codereview.appspot.com/6816114/diff/1/README#newcode16 README:16: sudo apt-get install golang-go I rather like '$' prefixes when documenting shell input. https://codereview.appspot.com/6816114/diff/1/README#newcode57 README:57: At this point you will have the bzr working copy of the juju-core source at $GOPATH/launchpad.net/juju-core. The source for any dependant packages will also be available inside $GOPATH. You can use bzr pull, or the less convenient go get -u launchpad.net/juju-core/... to update the source from time to time. If you want to know more about contributing to juju-core, please read the CONTRIBUTING companion to this file. s/dependant/dependent/ (unless you're deliberately adjectiving the noun?) https://codereview.appspot.com/6816114/diff/1/README#newcode74 README:74: The `juju` client program, and the juju 'tools' are deployed in lockstep. When a released of juju-core is made, the compiled tools matching that version of juju are extracted and uploaded to a known location. This consumes a release version number, and implies that no tools are available for the next, development, version of juju. Therefore, when using the development version of juju you will need to pass an additional flag, --upload-tools to instruct the `juju` client to build a set of tools from source and upload them to the environment as part of the bootstrap process. s/released of/release of/
Sign in to reply to this message.
TY, will fix line lengths and dumb ass spelling mistakes. On Mon, Nov 12, 2012 at 6:37 PM, <fwereade@gmail.com> wrote: > Essentially LGTM; really just suggestions. > > > https://codereview.appspot.com/6816114/diff/1/README > File README (right): > > https://codereview.appspot.com/6816114/diff/1/README#newcode16 > README:16: sudo apt-get install golang-go > I rather like '$' prefixes when documenting shell input. > > https://codereview.appspot.com/6816114/diff/1/README#newcode57 > README:57: At this point you will have the bzr working copy of the > > juju-core source at $GOPATH/launchpad.net/juju-core. The source for any > dependant packages will also be available inside $GOPATH. You can use > bzr pull, or the less convenient go get -u launchpad.net/juju-core/... > to update the source from time to time. If you want to know more about > contributing to juju-core, please read the CONTRIBUTING companion to > this file. > s/dependant/dependent/ (unless you're deliberately adjectiving the > noun?) > > https://codereview.appspot.com/6816114/diff/1/README#newcode74 > README:74: The `juju` client program, and the juju 'tools' are deployed > > in lockstep. When a released of juju-core is made, the compiled tools > matching that version of juju are extracted and uploaded to a known > location. This consumes a release version number, and implies that no > tools are available for the next, development, version of juju. > Therefore, when using the development version of juju you will need to > pass an additional flag, --upload-tools to instruct the `juju` client to > build a set of tools from source and upload them to the environment as > part of the bootstrap process. > s/released of/release of/ > > https://codereview.appspot.com/6816114/
Sign in to reply to this message.
one more note via IRC https://codereview.appspot.com/6816114/diff/1/README File README (right): https://codereview.appspot.com/6816114/diff/1/README#newcode44 README:44: sudo apt-get install mongodb build-essential bzr We also need 'zip' and 'git' (maybe one or both are covered under build-essential? sorry, this is a second-hand comment from IRC)
Sign in to reply to this message.
https://codereview.appspot.com/6816114/diff/1/README File README (right): https://codereview.appspot.com/6816114/diff/1/README#newcode44 README:44: sudo apt-get install mongodb build-essential bzr On 2012/11/12 13:57:26, fwereade wrote: > We also need 'zip' and 'git' > > (maybe one or both are covered under build-essential? sorry, this is a > second-hand comment from IRC) Sorry, it's 'zip' and 'git-core'.
Sign in to reply to this message.
https://codereview.appspot.com/6816114/diff/1/README File README (right): https://codereview.appspot.com/6816114/diff/1/README#newcode4 README:4: juju is devops distilled. Do we really want to start like this? It's meaningless and I know a few ops people that have stopped reading when they saw that. https://codereview.appspot.com/6816114/diff/1/README#newcode9 README:9: juju-core is written in Go (http://golang.org), a modern, compiled, statically typed, concurrent language. This document describes how to build juju-core from source. If you are looking for binary releases of juju-core, they are available from the Gophers PPA, https://launchpad.net/~gophers/+archive/go. Should we mention something about Ubuntu here? https://codereview.appspot.com/6816114/diff/1/README#newcode16 README:16: sudo apt-get install golang-go On 2012/11/12 07:37:58, fwereade wrote: > I rather like '$' prefixes when documenting shell input. Makes copy paste harder. https://codereview.appspot.com/6816114/diff/1/README#newcode27 README:27: Various conventions exist for naming the location of your GOPATH, but it should exist, be writable by you, and not overlap with the source for Go itself (if you have built Go from source). For example This parenthetical remark is wrong, and I believe we don't need it anyway. https://codereview.appspot.com/6816114/diff/1/README#newcode53 README:53: This command will checkout the source of juju-core and inspect it for any unmet Go package dependencies, and download those as well. go get will also build and install juju-core and it's dependencies, to skip this step, use the -d flag. More details on the go get flags are available using To download without installing, use the -d flag. I was a little unsure about what "this step" means :-). https://codereview.appspot.com/6816114/diff/1/README#newcode64 README:64: Will build juju and install the binary commands into $GOPATH/bin. It is likely if you have just completed the previous step to get the juju-core source, the install process will produce no output, as the final executables are up-to-date. s/It is likely//
Sign in to reply to this message.
Please take a look. https://codereview.appspot.com/6816114/diff/1/README File README (right): https://codereview.appspot.com/6816114/diff/1/README#newcode4 README:4: juju is devops distilled. On 2012/11/12 22:44:46, aram wrote: > Do we really want to start like this? It's meaningless and I know a few ops > people that have stopped reading when they saw that. I like it, it's a good tagline. https://codereview.appspot.com/6816114/diff/1/README#newcode9 README:9: juju-core is written in Go (http://golang.org), a modern, compiled, statically typed, concurrent language. This document describes how to build juju-core from source. If you are looking for binary releases of juju-core, they are available from the Gophers PPA, https://launchpad.net/~gophers/+archive/go. On 2012/11/12 22:44:46, aram wrote: > Should we mention something about Ubuntu here? Sure, what should I say ? https://codereview.appspot.com/6816114/diff/1/README#newcode16 README:16: sudo apt-get install golang-go On 2012/11/12 07:37:58, fwereade wrote: > I rather like '$' prefixes when documenting shell input. I'm with aram here, without fancy css to make the shell prefix unselectable, i'd prefer to elide them unless they are necessary to demonstate 'this is a command', and here is its output. https://codereview.appspot.com/6816114/diff/1/README#newcode27 README:27: Various conventions exist for naming the location of your GOPATH, but it should exist, be writable by you, and not overlap with the source for Go itself (if you have built Go from source). For example On 2012/11/12 22:44:46, aram wrote: > This parenthetical remark is wrong, and I believe we don't need it anyway. Well, technically this is the one warning the go tool does give you, there is code in there to stop you doing just this. In general I am exasperated by the amount of words that have to be written about GOPATH. It is astounding how something so simple can be so hard for people to understand. https://codereview.appspot.com/6816114/diff/1/README#newcode44 README:44: sudo apt-get install mongodb build-essential bzr On 2012/11/12 14:05:47, fwereade wrote: > On 2012/11/12 13:57:26, fwereade wrote: > > We also need 'zip' and 'git' > > > > (maybe one or both are covered under build-essential? sorry, this is a > > second-hand comment from IRC) > > Sorry, it's 'zip' and 'git-core'. From memory neither are covered by build-essential, added. https://codereview.appspot.com/6816114/diff/1/README#newcode53 README:53: This command will checkout the source of juju-core and inspect it for any unmet Go package dependencies, and download those as well. go get will also build and install juju-core and it's dependencies, to skip this step, use the -d flag. More details on the go get flags are available using On 2012/11/12 22:44:46, aram wrote: > To download without installing, use the -d flag. > > I was a little unsure about what "this step" means :-). > Done. https://codereview.appspot.com/6816114/diff/1/README#newcode57 README:57: At this point you will have the bzr working copy of the juju-core source at $GOPATH/launchpad.net/juju-core. The source for any dependant packages will also be available inside $GOPATH. You can use bzr pull, or the less convenient go get -u launchpad.net/juju-core/... to update the source from time to time. If you want to know more about contributing to juju-core, please read the CONTRIBUTING companion to this file. On 2012/11/12 07:37:58, fwereade wrote: > s/dependant/dependent/ (unless you're deliberately adjectiving the noun?) Done.
Sign in to reply to this message.
I forgot to LGTM https://codereview.appspot.com/6816114/diff/1/README File README (right): https://codereview.appspot.com/6816114/diff/1/README#newcode9 README:9: juju-core is written in Go (http://golang.org), a modern, compiled, statically typed, concurrent language. This document describes how to build juju-core from source. If you are looking for binary releases of juju-core, they are available from the Gophers PPA, https://launchpad.net/~gophers/+archive/go. > Sure, what should I say ? What about on recent Ubuntu releases they are available from the Gophers PPA Or If you are looking for binary releases of juju-core for recent Ubuntu releases, they are available from the Gophers PPA
Sign in to reply to this message.
LGTM https://codereview.appspot.com/6816114/diff/7001/README File README (right): https://codereview.appspot.com/6816114/diff/7001/README#newcode41 README:41: will create three sub directories inside your `GOPATH` when required; `src`, s/sub directories/subdirectories/ ? https://codereview.appspot.com/6816114/diff/7001/README#newcode46 README:46: should be exported as part of your login script. You can check that your s/check that/check/ https://codereview.appspot.com/6816114/diff/7001/README#newcode87 README:87: if you have just completed the previous step to get the `juju-corei` source, the s/corei/core/ https://codereview.appspot.com/6816114/diff/7001/README#newcode94 README:94: `GOPATH/bin/juju`. You should ensure that this version of `juju` appears higher s/higher/earlier/? https://codereview.appspot.com/6816114/diff/7001/README#newcode96 README:96: commands. Mention that you can verify this with `which juju`, maybe?
Sign in to reply to this message.
*** Submitted: Add README R=fwereade, aram CC= https://codereview.appspot.com/6816114 https://codereview.appspot.com/6816114/diff/7001/README File README (right): https://codereview.appspot.com/6816114/diff/7001/README#newcode41 README:41: will create three sub directories inside your `GOPATH` when required; `src`, On 2012/11/13 10:39:15, fwereade wrote: > s/sub directories/subdirectories/ > > ? Done. https://codereview.appspot.com/6816114/diff/7001/README#newcode46 README:46: should be exported as part of your login script. You can check that your On 2012/11/13 10:39:15, fwereade wrote: > s/check that/check/ Done. https://codereview.appspot.com/6816114/diff/7001/README#newcode87 README:87: if you have just completed the previous step to get the `juju-corei` source, the On 2012/11/13 10:39:15, fwereade wrote: > s/corei/core/ Done. https://codereview.appspot.com/6816114/diff/7001/README#newcode94 README:94: `GOPATH/bin/juju`. You should ensure that this version of `juju` appears higher On 2012/11/13 10:39:15, fwereade wrote: > s/higher/earlier/? Done. https://codereview.appspot.com/6816114/diff/7001/README#newcode96 README:96: commands. On 2012/11/13 10:39:15, fwereade wrote: > Mention that you can verify this with `which juju`, maybe? Done.
Sign in to reply to this message.
|
