Hi,<div><br></div><div>I'm still on silver wedding journey, so I'm not snchronized with all discussions. Currently I'm supporting Nick writing the do<span></span>cs from the user perspective, but I'm thinking about the dev docs since a longer time. So I'm raising my hand for writing those docs when I'm back next week. </div>
<div><br></div><div>mue<br><br>Am Mittwoch, 7. Mai 2014 schrieb Tim Penhey :<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Here are some notes from the discussion we had last week.<br>

<br>
A key part was to make sure that the developer documentation was<br>
available outside the actual source tree.  We thought something like:<br>
<br>
   <a href="https://juju.ubuntu.com/dev/" target="_blank">https://juju.ubuntu.com/dev/</a> - Developer Documentation<br>
<br>
The actual files are in the source tree in the doc directory, and we<br>
have a process (read script magic) that takes the markdown formatted<br>
local files and creates pretty HTML for the website.  This should happen<br>
automagically every time we have a stable release.<br>
<br>
There was a list of topics that we need to make sure are covered:<br>
<br>
  * Architecture overview<br>
  * API overview<br>
  * Writing new API calls<br>
  * What is in state (our persistent store - horrible name, I know)<br>
  * How the mgo transactions work<br>
  * How to write tests<br>
     * base suites<br>
     * environment isolation<br>
     * patch variables and environment<br>
     * using gocheck (filter and verbose)<br>
     * table based tests vs. simple tests<br>
     * test should be small and obviously correct<br>
  * Developer environment setup<br>
  * How to run the tests<br>
     * juju test <filter> --no-log (plugin)<br>
<br>
<br>
And a side note:<br>
  <a href="https://juju.ubuntu.com/install/" target="_blank">https://juju.ubuntu.com/install/</a> should say install juju-local<br>
<br>
Now we need people to put their hands up and write the docs.  Since I'm<br>
first, I get to choose first (bwahaha), and I choose the "how to write<br>
tests".<br>
<br>
I'm also pretty keen on the 'juju-test' plugin.  Partly because I don't<br>
like typing the command line args all the time for verbose logs and<br>
filter stuff, so would like it easier.<br>
<br>
I think a side part of the juju-test plugin is that it is conceivable<br>
that the plugin could output subunit output (optionally) for hooking<br>
into other test tools.<br>
<br>
I have a feeling that there will be some files in the doc directory that<br>
we don't want up on the website (maybe), so I envision that someone will<br>
end up writing the script that manages the structure and conversion of<br>
the raw files.<br>
<br>
Comments or claims?<br>
<br>
Tim<br>
<br>
--<br>
Juju-dev mailing list<br>
<a href="javascript:;" onclick="_e(event, 'cvml', 'Juju-dev@lists.ubuntu.com')">Juju-dev@lists.ubuntu.com</a><br>
Modify settings or unsubscribe at: <a href="https://lists.ubuntu.com/mailman/listinfo/juju-dev" target="_blank">https://lists.ubuntu.com/mailman/listinfo/juju-dev</a><br>
</blockquote></div><br><br>-- <br><div>** Frank Mueller <<a href="mailto:frank.mueller@canonical.com" target="_blank">frank.mueller@canonical.com</a>></div><div>** Software Engineer - Juju Development</div><div>** Canonical</div>
<br>