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
=== modified file 'htmldocs/tools-charm-tools.html'
--- htmldocs/tools-charm-tools.html 2013-11-01 03:28:05 +0000
+++ htmldocs/tools-charm-tools.html 2013-12-13 03:07:27 +0000
@@ -20,16 +20,8 @@
20 <![endif]-->20 <![endif]-->
21 </head>21 </head>
22<!--End-Head-->22<!--End-Head-->
23
24
25
26
27
28
29 <body class="resources">23 <body class="resources">
30
31<!--Header-->24<!--Header-->
32
33 <header class="banner global" role="banner">25 <header class="banner global" role="banner">
34 <nav role="navigation" class="nav-primary nav-right">26 <nav role="navigation" class="nav-primary nav-right">
35 <div class="logo">27 <div class="logo">
@@ -52,7 +44,7 @@
52 <label class="off-left" for="s">Search:</label>44 <label class="off-left" for="s">Search:</label>
53 <input class="form-text" type="text" value="" name="s" id="s" />45 <input class="form-text" type="text" value="" name="s" id="s" />
54 <button class="off-left form-submit" type="submit" id="searchsubmit">Search</button>46 <button class="off-left form-submit" type="submit" id="searchsubmit">Search</button>
55 </form> 47 </form>
56 </div>48 </div>
57 </nav> 49 </nav>
58 </header>50 </header>
@@ -90,7 +82,7 @@
90 <div data-section="osx">82 <div data-section="osx">
91 <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>83 <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>
92 <p>To install, run the following:</p>84 <p>To install, run the following:</p>
93 <pre class="prettyprint lang-bash">brew install juju</pre>85 <pre class="prettyprint lang-bash">brew install charm-tools</pre>
94 </div>86 </div>
95 <div data-section="windows">87 <div data-section="windows">
96 <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>88 <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>
@@ -106,6 +98,19 @@
106 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>98 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>
107 <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 have99 <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
108 independent help pages, accesible using either the <code>-h</code> or <code>--help</code> flags.</p>100 independent help pages, accesible using either the <code>-h</code> or <code>--help</code> flags.</p>
101 <h2 id="add">Add</h2>
102 <pre class="prettyprint lang-bash">juju charm add [-h|--help] tests,readme [CHARM_DIRECTORY]</pre>
103 <p>Add is a generator function which can be used to extend a charm depending on the subcommand issued.</p>
104 <h3 id="add-readme">Readme</h3>
105 <p><code>readme</code> will create a <code>README.ex</code> in the <code>CHARM_DIRECTORY</code> from the template charm.</p>
106 <h4 id="add-readme-example">Add Readme Example</h4>
107 <pre class="prettyprint lang-bash">juju charm add readme</pre>
108 <h3 id="add-tests">Tests</h3>
109 <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
110 <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>
111 <h4 id="add-tests-example">Add Tests Example</h4>
112 <pre class="prettyprint lang-bash">juju charm add tests</pre>
113 <hr>
109 <h2 id="create">Create</h2>114 <h2 id="create">Create</h2>
110 <pre class="prettyprint lang-bash">juju charm create [-h|--help] CHARM_NAME [CHARMS_DIRECTORY]</pre>115 <pre class="prettyprint lang-bash">juju charm create [-h|--help] CHARM_NAME [CHARMS_DIRECTORY]</pre>
111 <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> with116 <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
@@ -147,6 +152,14 @@
147 <p>Similar to <a href="#get"><code>get</code></a>, <code>getall</code> will fetch all official charm store charms and place them in the152 <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
148 <code>CHARMS_DIRECTORY</code>, or your current directory if no <code>CHARMS_DIRECTORY</code> is provided. This command can take quite</p>153 <code>CHARMS_DIRECTORY</code>, or your current directory if no <code>CHARMS_DIRECTORY</code> is provided. This command can take quite</p>
149 <hr>154 <hr>
155 <h2 id="info">Info</h2>
156 <pre class="prettyprint lang-bash">juju charm info [-h|--help] [CHARM]</pre>
157 <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
158 deploy a charm with <code>juju deploy</code>, with the exception of <code>local:</code>, can be used with this command.</p>
159 <h3 id="info-example">Info Example</h3>
160 <p>This will print the raw README for the WordPress charm</p>
161 <pre class="prettyprint lang-bash">juju charm info wordpress</pre>
162 <hr>
150 <h2 id="list">List</h2>163 <h2 id="list">List</h2>
151 <pre class="prettyprint lang-bash">juju charm list [-h|--help]</pre>164 <pre class="prettyprint lang-bash">juju charm list [-h|--help]</pre>
152 <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>165 <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