Merge lp:~mbruzek/juju-core/fixed-404-in-authors-charm-writing into lp:juju-core/docs

[Matt Bruzek]

I fixed a 404 link in the author-charm-writing page.
Removed an extra unordered list close tag to correct formatting.
Changed hok to hook.
Replaced evilnick with $USER and removed "local" to match the command that
was used to create the "charm" directory.

[Nick Veitch (evilnick)]

thanks!

review: Approve

[Matt Bruzek (mbruzek)]

Hi Nick,

Thanks for the review! I have a second change set out there that converts
the additional references to the *content.html to *components.html

I emailed Antonio and he said I should merge these changes by following the
process: https://juju.ubuntu.com/docs/contributing.html

I am still fairly new to bzr. I do not see any advice on when to run the
merge command, so I googled it.
http://doc.bazaar.canonical.com/beta/en/user-guide/merging_changes.html

So it looks like I do a *$ bzr merge* followed by *$ bzr commit -m "Merge
comment"* is that correct?

I am worried about doing something out of order or pushing a merge before
an approve is done will cause problems. Is there anything I have to wait
for before I merge? You reviewed/approved one change but my second change
set has not been reviewed and approved. What is the process (if any) for
merges?

Thanks,

*Matthew Bruzek*
<email address hidden>
507.269.0012 mobile
http://www.linkedin.com/in/matthewbruzek/

On Fri, Nov 8, 2013 at 4:19 AM, Nick Veitch <email address hidden>wrote:

> Review: Approve
>
> thanks!
> --
>
> https://code.launchpad.net/~mbruzek-s/juju-core/fixed-404-in-authors-charm-writing/+merge/194450
> You are the owner of
> lp:~mbruzek-s/juju-core/fixed-404-in-authors-charm-writing.
>

=== modified file 'htmldocs/authors-charm-writing.html'
--- htmldocs/authors-charm-writing.html	2013-10-10 01:00:24 +0000
+++ htmldocs/authors-charm-writing.html	2013-11-08 05:45:13 +0000
@@ -169,11 +169,11 @@
 <span class="number" > 4 </span>
           <div class="step" id="step04">
           <h2>Writing hooks</h2>
-          <p>As you will know from your thorough reading of the <a href="./authors-charm-contents.html">charm contents</a>, the hooks are the important scripts that actually do things. You can write hooks in whatever language you can reasonably expect to execute on an Ubuntu server.</p>
+          <p>As you will know from your thorough reading of the <a href="./authors-charm-components.html">charm components</a>, the hooks are the important scripts that actually do things. You can write hooks in whatever language you can reasonably expect to execute on an Ubuntu server.</p>
           <p>For our charm, the hooks we will need to create are:</p>
           <ul>
           <li>start - for when the service needs to be started.</li>
-          <li>stop - for stopping it again.</li></ul>
+          <li>stop - for stopping it again.</li>
           <li>install - for actually fetching and installing the Vanilla code.</li>
           <li>database-relation-changed - this will run when we connect (or re-connect, or disconnect) our service to the MySQL database. This hook will need to manage this connection.</li>
           <li>website-relation-joined - this will run when/if a service connects to our charm.</li>
@@ -287,7 +287,7 @@
 </pre>
 
 <p>You will notice that this script uses the backticked command <span class="pre">relation-get</span>. This is a Juju helper command that fetches the named values from the corresponding hook on the service we are connecting to.
-Usually there will be some indication of what these values are, but you can always inspect the corresponding hoks to find out. In this case we know that when connected, the MySQL charm will create a database and generate random values for things like a username and password.</p>
+Usually there will be some indication of what these values are, but you can always inspect the corresponding hooks to find out. In this case we know that when connected, the MySQL charm will create a database and generate random values for things like a username and password.</p>
 <p>These values will all be set at one time, so the next little bit of script just checks one value to see if it exists - if not the corresponding charm hasn't set the values yet.</p>
 <p>When it has the values we can use these to modify the config file for Vanilla in the relevant place, and finally open the port to make the service active.</p>
 <p>The final hook we need to write is for other services which may want to consume Vanilla, 'website-relation-joined'.</p>
@@ -307,7 +307,7 @@
           <p>This starts a process to tail the Juju log file and show us just exactly what is happening. It won't do much to begin with, but you should see messages appearing when we start to deploy our charm.</p>
           <p>Following our own recipe, in another terminal we should now do the following (assuming you already have a bootstrapped environment):</p>
           <pre>juju deploy mysql
-juju deploy --repository=/home/evilnick/localcharms/ local:precise/vanilla
+juju deploy --repository=/home/$USER/charms/ local:precise/vanilla
 juju add-relation mysql vanilla
 juju expose vanilla
 </pre>