juju-core

Merge lp:~marcoceppi/juju-core/docs-charm-tools-1.2.4 into lp:juju-core/docs

  1. docs-charm-tools-1.2.4
  2. Merge into docs
Proposed by Marco Ceppi
Status: Merged
Approved by: Nick Veitch
Approved revision: no longer in the source branch.
Merged at revision: 202
Proposed branch: lp:~marcoceppi/juju-core/docs-charm-tools-1.2.4
Merge into: lp:juju-core/docs
Diff against target: 73 lines (+23/-10)
1 file modified
htmldocs/tools-charm-tools.html (+23/-10)
To merge this branch: bzr merge lp:~marcoceppi/juju-core/docs-charm-tools-1.2.4
Reviewer Review Type Date Requested Status
charmers Pending
Review via email: mp+198861@code.launchpad.net

Description of the change

Update charm-tools docs to include new features for 1.2 series

To post a comment you must log in.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'htmldocs/tools-charm-tools.html'
2--- htmldocs/tools-charm-tools.html 2013-11-01 03:28:05 +0000
3+++ htmldocs/tools-charm-tools.html 2013-12-13 03:07:27 +0000
4@@ -20,16 +20,8 @@
5 <![endif]-->
6 </head>
7 <!--End-Head-->
8-
9-
10-
11-
12-
13-
14 <body class="resources">
15-
16 <!--Header-->
17-
18 <header class="banner global" role="banner">
19 <nav role="navigation" class="nav-primary nav-right">
20 <div class="logo">
21@@ -52,7 +44,7 @@
22 <label class="off-left" for="s">Search:</label>
23 <input class="form-text" type="text" value="" name="s" id="s" />
24 <button class="off-left form-submit" type="submit" id="searchsubmit">Search</button>
25- </form>
26+ </form>
27 </div>
28 </nav>
29 </header>
30@@ -90,7 +82,7 @@
31 <div data-section="osx">
32 <p>Charm Tools is available via <a href="http://brew.sh/" target="_blank">Homebrew</a>. Make sure you're running the latest version of homebrew before proceeding.</p>
33 <p>To install, run the following:</p>
34- <pre class="prettyprint lang-bash">brew install juju</pre>
35+ <pre class="prettyprint lang-bash">brew install charm-tools</pre>
36 </div>
37 <div data-section="windows">
38 <p>Charm Tools is available for, and tested, on Microsoft Windows 7 and 8. While the installer may work on previous versions of Windows there is no guarentee.</p>
39@@ -106,6 +98,19 @@
40 If you wish to use the stand alone client, or don't have juju installed, you can replace all instances of <code>juju charm</code> with just <code>charm</code>.</p>
41 <p>There are several tools available within charm tools itself. At any time you can run <code>juju charm</code> to view the available subcommands and all subcommands have
42 independent help pages, accesible using either the <code>-h</code> or <code>--help</code> flags.</p>
43+ <h2 id="add">Add</h2>
44+ <pre class="prettyprint lang-bash">juju charm add [-h|--help] tests,readme [CHARM_DIRECTORY]</pre>
45+ <p>Add is a generator function which can be used to extend a charm depending on the subcommand issued.</p>
46+ <h3 id="add-readme">Readme</h3>
47+ <p><code>readme</code> will create a <code>README.ex</code> in the <code>CHARM_DIRECTORY</code> from the template charm.</p>
48+ <h4 id="add-readme-example">Add Readme Example</h4>
49+ <pre class="prettyprint lang-bash">juju charm add readme</pre>
50+ <h3 id="add-tests">Tests</h3>
51+ <p><code>tests</code> will create a tests directory for a charm and generate an example test using the Amulet framework. This command will ingest relation data from the charm
52+ <code>metadata.yaml</code> and create test file, <code>00-autogen</code>, based on matching charms to the interfaces listed. This is merely an example to start with and will need to be modified.</p>
53+ <h4 id="add-tests-example">Add Tests Example</h4>
54+ <pre class="prettyprint lang-bash">juju charm add tests</pre>
55+ <hr>
56 <h2 id="create">Create</h2>
57 <pre class="prettyprint lang-bash">juju charm create [-h|--help] CHARM_NAME [CHARMS_DIRECTORY]</pre>
58 <p>This command, <code>create</code>, will produce a boilerplate template of a charm to expedite the charm creation process. Replace <code>CHARM_NAME</code> with
59@@ -147,6 +152,14 @@
60 <p>Similar to <a href="#get"><code>get</code></a>, <code>getall</code> will fetch all official charm store charms and place them in the
61 <code>CHARMS_DIRECTORY</code>, or your current directory if no <code>CHARMS_DIRECTORY</code> is provided. This command can take quite</p>
62 <hr>
63+ <h2 id="info">Info</h2>
64+ <pre class="prettyprint lang-bash">juju charm info [-h|--help] [CHARM]</pre>
65+ <p>Info is used to query the README file for a charm. This command accepts various forms of a valid "charm id". Any ID that can be used to
66+ deploy a charm with <code>juju deploy</code>, with the exception of <code>local:</code>, can be used with this command.</p>
67+ <h3 id="info-example">Info Example</h3>
68+ <p>This will print the raw README for the WordPress charm</p>
69+ <pre class="prettyprint lang-bash">juju charm info wordpress</pre>
70+ <hr>
71 <h2 id="list">List</h2>
72 <pre class="prettyprint lang-bash">juju charm list [-h|--help]</pre>
73 <p>Show all charms (both official and person) in the charm store. This produces an exhaustive list of all charms available in the store.</p>

Subscribers

People subscribed via source and target branches