Skip to content

Commit

Permalink
Initial move of OpenStack Object Storage API guide to github repo
Browse files Browse the repository at this point in the history 
Change-Id: I90fe30c6d542f02bc12fd7d651cc70828363a355
  • Loading branch information
Anne Gentle committed Sep 9, 2011
1 parent b8d430c commit ac49d00
Show file tree
Hide file tree
Showing 8 changed files with 2,024 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
View file
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,2 @@
.DS_Store?
target/
9 changes: 9 additions & 0 deletions README
View file
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,9 @@
This repository contains the RESTful API information for the OpenStack Object Storage Service, also known as Swift. The Swift project provides services for object storage and retrieval as well as assigning metadata.

Contributing
============
Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

Installing
==========
Refer to http://swift.openstack.org to learn more about installing an OpenStack Object Storage server that can respond to these API commands.
131 changes: 131 additions & 0 deletions openstack-object-storage-dev/pom.xml
View file
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,131 @@

<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<groupId>org.openstack.docs</groupId>
<artifactId>openstack-object-api-guide</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>OpenStack Guides</name>
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<profiles>
<profile>
<id>Rackspace Research Repositories</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>

<build>
<resources>
<resource>
<directory>target/docbkx/pdf</directory>
<excludes>
<exclude>**/*.fo</exclude>
</excludes>
</resource>
</resources>
<plugins>

<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.0.5-SNAPSHOT</version>
<executions>
<execution>
<id>goal1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<highlightSource>false</highlightSource>
</configuration>
</execution>
<execution>
<id>goal2</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<!-- These parameters only apply to webhelp -->
<enableDisqus>0</enableDisqus>
<disqusShortname>openstackdocs</disqusShortname>
<enableGoogleAnalytics>1</enableGoogleAnalytics>
<googleAnalyticsId>UA-17511903-6</googleAnalyticsId>
<generateToc>
appendix toc,title
article/appendix nop
article toc,title
book title,figure,table,example,equation
chapter toc,title
part toc,title
preface toc,title
qandadiv toc
qandaset toc
reference toc,title
set toc,title
</generateToc>
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
<sectionAutolabel>0</sectionAutolabel>
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>
<postProcess>
<!-- Copies the figures to the correct location for webhelp -->
<!-- No figures in this book -->

<!-- Copies HTML to a release folder --> <copy
todir="${basedir}/target/docbkx/webhelp/trunk/openstack-object-storage/developer">
<fileset
dir="${basedir}/target/docbkx/webhelp/os-objectstorage-devguide">
<include name="**/*" />
</fileset>
</copy>

<!--Moves PDFs to the needed placement -->

<move failonerror="false"
file="${basedir}/target/docbkx/pdf/os-objectstorage-devguide.pdf"
tofile="${basedir}/target/docbkx/webhelp/trunk/openstack-object-storage/developer/os-objectstorage-devguide-trunk.pdf"/>

<delete
dir="${basedir}/target/docbkx/webhelp/os-objectstorage-devguide"/>
</postProcess>
</configuration>
</execution>
</executions>
<configuration>
<!-- These parameters apply to pdf and webhelp -->
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src/docbkx</sourceDirectory>
<includes>
os-objectstorage-devguide.xml
</includes>
<profileSecurity>reviewer</profileSecurity>
<branding>openstack</branding>
</configuration>
</plugin>

</plugins>
</build>
</project>
Loading

0 comments on commit ac49d00

Please sign in to comment.