Code review comment for lp:~kim0/pyjuju/user-tutorial-and-FAQ

Revision history for this message
Gustavo Niemeyer (niemeyer) wrote :

Wow, this is *awesome* Ahmed. Thanks a lot!

I have several minor nits only due to the doc size, but it's indeed very
good overall.

Would you mind to check these out and let me know what you think?

[1]

+User Tutorial

Can you please lowercase the "Tutorial"? We had casing mixed up, and since the last doc
polishing I'm trying to have all documents standardizing around "Title case", so that
we have some consistency there.

[2]

10 + The name Ensemble is rooted in group communication systems and paxos, where

The Ensemble term actually comes from the meaning of the "ensemble" word itself:

"an assemblage of parts or details (as in a work of art) considered as forming a whole"

[3]

+ servers. Another way to look at it, is that Ensemble helps you manage an

s/,//

[4]

+ make those services communicate through a simple protocol. Users can then

s/communicate/coordinate their communication/

[5]

+ ready to be used in production. However adventerous users are encouraged to

s/However /However, /

s/adventerous/adventurous/

[6]

+ Ensemble itself is developed using python. However writing formulas for

s/However /However, /

[7]

37 + Ensemble can be done in any language. All Ensemble cares about is finding a
38 + set of executable files, which it will trigger appropriately. Hooks can be
39 + written in a variety of languages such as bash, python, perl, c++ and
40 + others

Might be better to end the paragraph in "appropriately.". It already said it
can be written in *any* language, so there's no need to give examples.

[8]

109 +Note the following, machine "0" has been started. This is usually the
110 +bootstrapping node and the first node to be started. The dns-name for the node

s/usually//, both affirmations are necessarily true.

[9]

+is printed. Also the ec2 instance-id is printed. Since no services are yet

s/ec2/EC2/

[10]

+This will connect to the environment, and start tailing logs

s/logs/logs./

[11]

+Deploying Service Units

s/S/s/ and s/U/u/, same as [1].

[12]

+We can see a new ec2 instance has now been spun up for mysql. Information for

s/ec2/EC2/

[13]

171 +We can see a new ec2 instance has now been spun up for mysql. Information for
172 +this instance is displayed as machine number 1. Mysql is now listed under
173 +services, it is apparent the mysql service unit has no relations, since it

Minor sentence refactoring:

  We can see a new ec2 instance has now been spun up for mysql. Information for
  this instance is displayed as machine number 1 and mysql is now listed under
  services. It is apparent that the mysql service unit has no relations, since it

[14]

174 +has not been connected to wordpress yet. Since this is the first mysql service
175 +unit, it is being referred to as mysql/0, subsequent service units would be

It would be nice to mention here, even if very briefly, the distinction between a
service and a service unit.

[15]

183 +Waiting a minute for all services to complete their configuration cycle and
184 +get properly started, then issuing a status command::

s/Waiting a/Let's wait for a/
s/then issuing/then issue/

[16]

+Adding Relation

=> "Adding a relation"

[17]

+Tracing Hook Execution

=> "Tracing hook execution"

[18]

261 +While not necessary for an Ensemble user to trace the execution order of hooks,
262 +it is often of great value to do so. Understanding hook order execution, the
263 +parallel nature of hook execution across instances, and how relation-set in a
264 +hook can trigger the execution of another hook is quite important to grasp.

It shouldn't be important for a user which is getting the first contact
with Ensemble for the *deployment* of services. It's nice to present this
information, but I think we should sell it more as curiosity for understanding
the internals than as something important to grasp upfront.

[19]

265 +Here are a few important messages from the debug-log of this Ensemble run. I
266 +have deliberately left the date field in this log, in order to understand the
267 +parallel nature of hook execution.

This is the only instance of "I" in the whole tutorial. I suggest taking it out
so that it stays in the editorial "we". You can do that by changing the sentence like:

"The date field has been deliberately left in this log, ..."

[20]

+Destroying the Environment

s/Envir/envir/

review: Approve

« Back to merge proposal