Merge lp:~themue/juju-core/docs-001-fix-contributing-typos-and-double-subsection into lp:juju-core/docs

Proposed by Frank Mueller
Status: Merged
Approved by: Nick Veitch
Approved revision: no longer in the source branch.
Merge reported by: Nick Veitch
Merged at revision: not available
Proposed branch: lp:~themue/juju-core/docs-001-fix-contributing-typos-and-double-subsection
Merge into: lp:juju-core/docs
Diff against target: 40 lines (+4/-20)
1 file modified
htmldocs/contributing.html (+4/-20)
To merge this branch: bzr merge lp:~themue/juju-core/docs-001-fix-contributing-typos-and-double-subsection
Reviewer Review Type Date Requested Status
charmers Pending
Review via email: mp+183168@code.launchpad.net

Description of the change

Fixed typos and a double subsection in contributing.html.

To post a comment you must log in.
Revision history for this message
Nick Veitch (evilnick) wrote :

thanks!

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'htmldocs/contributing.html'
2--- htmldocs/contributing.html 2013-08-22 15:08:13 +0000
3+++ htmldocs/contributing.html 2013-08-30 13:29:27 +0000
4@@ -101,32 +101,16 @@
5 <p>If you find you need to add a page to the documentation, then you will also need to add it to the navigation, which means altering two additional files - navigation.html and navigation.json
6 <p>For navigation.json, you will need to enter a key:value pair in the appropriate location, e.g.:</p>
7 <pre><code>"Scaling Services": "charms-scaling.html",</code></pre>
8- <p>Not the quote marks, position of the colon, and the comma if required (i.e. if adding a page in the middle of a list). The same entry also needs to be included in the navigation.html page: </p>
9+ <p>Note the quote marks, position of the colon, and the comma if required (i.e. if adding a page in the middle of a list). The same entry also needs to be included in the navigation.html page: </p>
10 <pre><code>&LT;li class=" sub"&GT;&LT;a href="charms-scaling.html"&GT;Scaling Services&LT;/a&GT;&LT;/li&GT;</code></pre>
11 again in the appropriate section. Please make sure you submit a merge proposal with a description of the new page and why it is needed!
12
13 <h1>Testing or Deploying locally</h1>
14- <p>The documentation makes use of Javascript for some functionality, so in oreder to test the docs properly or serve them localy, you will need to have an http server set up.</p>
15+ <p>The documentation makes use of Javascript for some functionality, so in order to test the docs properly or serve them localy, you will need to have an http server set up.</p>
16 <p>On Ubuntu this is easy. Install (if you need to) and start the apache2 web server, then just copy the htmnldocs directory to a convenient location - </p>
17 <pre><code>sudo cp -R htmldocs /var/www/htmldocs</code></pre>
18- <p>You can then point your web browser at your loca machine (127.0.0.1/htmldocs) to view the files.</p>
19-
20- <h1>Submitting your work</h1>
21- <p>We love it when the community contributes to documentation, here's how to get the code, branch it, modify it, and submit it back. First off get the code:</p>
22- <pre>bzr branch lp:juju-core/docs</pre>
23- <p>Then go into the docs directory:</p>
24- <pre>cd docs/htmldocs</pre>
25- <p>In here you'll find the HTML files that you can edit in your text editor. After we make our changes we need to commit them and push them to your place on launchpad :</p>
26-
27- <pre>
28- bzr ci -m'Whatever your changelog will be'
29- bzr push lp:~jorge/juju-core/foo</pre>
30-
31- <p>Replace "~jorge" with your launchpad username and "foo" with a name that describes a fix, so something like <code>bzr push lp:~jorge/juju-core/fix-typos-in-introduction</code> or something. Now there's one step left, and that's to propose it for inclusion:</p>
32-
33- <pre>bzr lp-propose lp:juju-core/docs</pre>
34-
35- <p>And that's it! Someone from the Juju team will review your work and merge it in! Please don't forget to review the page before submission.</p>
36+ <p>You can then point your web browser at your local machine (127.0.0.1/htmldocs) to view the files.</p>
37+
38 <h2>Submitting your work</h2>
39 <p>We love it when the community contributes to documentation, here's how to get the code, branch it, modify it, and submit it back. First off get the code:</p>
40 <pre>bzr branch lp:juju-core/docs</pre>

Subscribers

People subscribed via source and target branches