Merge lp:~nwilliams/akiban-persistit/minor-doc-cleanup-for-oe into lp:akiban-persistit

Proposed by Nathan Williams
Status: Merged
Approved by: Nathan Williams
Approved revision: 320
Merged at revision: 315
Proposed branch: lp:~nwilliams/akiban-persistit/minor-doc-cleanup-for-oe
Merge into: lp:akiban-persistit
Diff against target: 105 lines (+33/-4)
2 files modified
pom.xml (+30/-1)
src/main/javadoc/overview.html (+3/-3)
To merge this branch: bzr merge lp:~nwilliams/akiban-persistit/minor-doc-cleanup-for-oe
Reviewer Review Type Date Requested Status
Akiban Build User Needs Fixing
Ariel Weil (community) documentation review Approve
Review via email: mp+108224@code.launchpad.net

Description of the change

Minor formatting, wording, and link clean-ups for the final docs.

Noticed a few typos and mis-formatting when looking over docs, so clean those up. Update final links and generalize script so it can build for both website and packages.

Minor wording changes for talking about licensing and add link to website with specifics.

Tweak Sphinx config to not put link to empty index, put real version number in it, and change name to Persistit.

To post a comment you must log in.
Revision history for this message
Ariel Weil (aweil) wrote :

The documentation looks good, and consistent with the way we're attempting to standardize on B+ tree in our docs. Thanks!

review: Approve (documentation review)
Revision history for this message
Akiban Build User (build-akiban) wrote :

There were 2 failures during build/test:

* job server-build failed at build number 2249: http://172.16.20.104:8080/job/server-build/2249/

* view must-pass failed: server-build is red

review: Needs Fixing
Revision history for this message
Nathan Williams (nwilliams) wrote :

Network, again.

Since there are no code changes at all here, I'll do this manually.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'pom.xml'
--- pom.xml 2012-05-31 01:50:15 +0000
+++ pom.xml 2012-05-31 21:10:23 +0000
@@ -1,17 +1,35 @@
1<?xml version="1.0"?>1<?xml version="1.0"?>
2<project>2<project>
3 <modelVersion>4.0.0</modelVersion>3 <modelVersion>4.0.0</modelVersion>
4
4 <groupId>com.akiban</groupId>5 <groupId>com.akiban</groupId>
5 <artifactId>akiban-persistit</artifactId>6 <artifactId>akiban-persistit</artifactId>
6 <name>akiban-persistit</name>
7 <version>3.1.1-SNAPSHOT</version>7 <version>3.1.1-SNAPSHOT</version>
8 <packaging>jar</packaging>8 <packaging>jar</packaging>
9
10 <name>akiban-persistit</name>
11 <inceptionYear>2005</inceptionYear>
12 <url>http://www.akiban.com/akiban-persistit</url>
13 <organization>
14 <name>Akiban Technologies, Inc</name>
15 <url>http://www.akiban.com</url>
16 </organization>
17
18 <licenses>
19 <license>
20 <name>GNU Affero General Public License, version 3</name>
21 <url>http://www.gnu.org/licenses/agpl-3.0.txt</url>
22 <distribution>repo</distribution>
23 </license>
24 </licenses>
25
9 <properties>26 <properties>
10 <!-- this is the default version number, Jenkins job sets this to the official number -->27 <!-- this is the default version number, Jenkins job sets this to the official number -->
11 <BZR_REVISION></BZR_REVISION>28 <BZR_REVISION></BZR_REVISION>
12 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>29 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
13 <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>30 <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
14 </properties>31 </properties>
32
15 <distributionManagement>33 <distributionManagement>
16 <snapshotRepository>34 <snapshotRepository>
17 <id>akiban</id>35 <id>akiban</id>
@@ -24,6 +42,7 @@
24 <url>http://akiban.artifactoryonline.com/akiban/libs-releases-local</url>42 <url>http://akiban.artifactoryonline.com/akiban/libs-releases-local</url>
25 </repository>43 </repository>
26 </distributionManagement>44 </distributionManagement>
45
27 <dependencies>46 <dependencies>
28 <dependency>47 <dependency>
29 <groupId>junit</groupId>48 <groupId>junit</groupId>
@@ -56,10 +75,19 @@
56 </exclusions>75 </exclusions>
57 </dependency>76 </dependency>
58 </dependencies>77 </dependencies>
78
59 <build>79 <build>
60 <finalName>${project.artifactId}-${project.version}${BZR_REVISION}</finalName>80 <finalName>${project.artifactId}-${project.version}${BZR_REVISION}</finalName>
61 <resources>81 <resources>
62 <resource>82 <resource>
83 <directory>${basedir}</directory>
84 <targetPath>META-INF</targetPath>
85 <filtering>false</filtering>
86 <includes>
87 <include>LICENSE.txt</include>
88 </includes>
89 </resource>
90 <resource>
63 <directory>src/main/resources</directory>91 <directory>src/main/resources</directory>
64 <filtering>true</filtering>92 <filtering>true</filtering>
65 <includes>93 <includes>
@@ -240,6 +268,7 @@
240 </plugin>268 </plugin>
241 </plugins>269 </plugins>
242 </build>270 </build>
271
243 <reporting>272 <reporting>
244 <plugins>273 <plugins>
245 <plugin>274 <plugin>
246275
=== modified file 'src/main/javadoc/overview.html'
--- src/main/javadoc/overview.html 2012-05-25 18:50:59 +0000
+++ src/main/javadoc/overview.html 2012-05-31 21:10:23 +0000
@@ -22,13 +22,13 @@
22<html>22<html>
23<body>23<body>
24<div id="header">24<div id="header">
25<h1>Persistit 2.2</h1>25<h1>Persistit 3.1.1</h1>
26</div>26</div>
27<div id="content">27<div id="content">
28<div id="preamble">28<div id="preamble">
29<div class="sectionbody">29<div class="sectionbody">
30<div class="paragraph"><p>Persistit&#8482; is a small, lightweight Java&#8482; library that provides simple, fast and reliable data persistence for Java applications. It is designed to be embedded in Java application programs and to operate free of administration by the end-user.</p></div>30<div class="paragraph"><p>Persistit&#8482; is a small, lightweight Java&#8482; library that provides simple, fast and reliable data persistence for Java applications. It is designed to be embedded in Java application programs and to operate free of administration by the end-user.</p></div>
31<div class="paragraph"><p>This section provides a brief overview. See <a href="http://www.akiban.com/persistit/documentation/">http://www.akiban.com/persistit/documentation/</a> for complete documentation.</p></div>31<div class="paragraph"><p>This section provides a brief overview. See <a href="http://www.akiban.com/ak-docs/admin/persistit">http://www.akiban.com/ak-docs/admin/persistit</a> for complete documentation.</p></div>
32</div>32</div>
33</div>33</div>
34<h2 id="_api_overview">API Overview</h2>34<h2 id="_api_overview">API Overview</h2>
@@ -201,7 +201,7 @@
201<div id="footnotes"><hr /></div>201<div id="footnotes"><hr /></div>
202<div id="footer">202<div id="footer">
203<div id="footer-text">203<div id="footer-text">
204Last updated 2011-04-25 13:13:54 EDT204Last updated 2012-05-31 17:00:00 EDT
205</div>205</div>
206</div>206</div>
207</body>207</body>

Subscribers

People subscribed via source and target branches