Setup for building the manual
With these changes, "mvn clean generate-sources" works. * Add missing files from openstack-manuals. * Change files so that links work. * Update pom.xml so that it works without parent. * Add usual .gitignore file. Change-Id: Iea1c68d7391804760e6677ee2cb22d07fe04a8f5
This commit is contained in:
Andreas Jaeger
parent
9b27279215
commit
c80823bc9b
24
.gitignore
vendored
Normal file
24
.gitignore
vendored
Normal file
@ -0,0 +1,24 @@
|
||||
.DS_Store
|
||||
*.xpr
|
||||
|
||||
# Packages
|
||||
.venv
|
||||
*.egg
|
||||
*.egg-info
|
||||
|
||||
# Testenvironment
|
||||
.tox
|
||||
|
||||
# Build directories
|
||||
target/
|
||||
publish-docs/
|
||||
generated/
|
||||
/build-*.log.gz
|
||||
|
||||
# Transifex Client Setting
|
||||
.tx
|
||||
|
||||
# Editors
|
||||
*~
|
||||
.*.swp
|
||||
.bak
|
||||
@ -66,7 +66,7 @@
|
||||
</revision>
|
||||
</revhistory>
|
||||
</info>
|
||||
<xi:include href="../common/ch_preface.xml"/>
|
||||
<xi:include href="http://git.openstack.org/cgit/openstack/openstack-manuals/plain/doc/common/ch_preface.xml" />
|
||||
<xi:include href="ch001_acknowledgements.xml"/>
|
||||
<xi:include href="ch002_why-and-how-we-wrote-this-book.xml"/>
|
||||
<xi:include href="ch004_book-introduction.xml"/>
|
||||
@ -122,6 +122,6 @@
|
||||
<xi:include href="ch064_certifications-compliance-statements.xml"/>
|
||||
<xi:include href="ch065_privacy.xml"/>
|
||||
<xi:include href="ch066_case-studies-compliance.xml"/>
|
||||
<xi:include href="../common/app_support.xml"/>
|
||||
<xi:include href="http://git.openstack.org/cgit/openstack/openstack-manuals/plain/doc/common/app_support.xml"/>
|
||||
<glossary role="auto"/>
|
||||
</book>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter [
|
||||
<!ENTITY % openstack SYSTEM "../common/entities/openstack.ent">
|
||||
<!ENTITY % openstack SYSTEM "openstack.ent">
|
||||
%openstack;
|
||||
]>
|
||||
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
|
||||
@ -246,7 +246,7 @@
|
||||
policies.</para>
|
||||
<para>Below is a snippet of the Block Storage service
|
||||
<filename>policy.json</filename> file.</para>
|
||||
<programlisting language="json"><xi:include href="../common/samples/authentication.json" parse="text"/></programlisting>
|
||||
<programlisting language="json"><xi:include href="http://git.openstack.org/cgit/openstack/openstack-manuals/plain/doc/common/samples/authentication.json" parse="text"/></programlisting>
|
||||
<para>Note the <emphasis role="bold">default</emphasis> rule
|
||||
specifies that the user must be either an admin or the owner of
|
||||
the volume. It essentially says only the owner of a volume or
|
||||
@ -269,7 +269,7 @@
|
||||
<para>The following example shows a PKI token. Note that, in
|
||||
practice, the token id value is about 3500 bytes. We shorten it
|
||||
in this example.</para>
|
||||
<programlisting language="json"><xi:include href="../common/samples/token.json" parse="text"/></programlisting>
|
||||
<programlisting language="json"><xi:include href="http://git.openstack.org/cgit/openstack/openstack-manuals/plain/doc/common/samples/token.json" parse="text"/></programlisting>
|
||||
<para>Note that the token is often passed within the structure of
|
||||
a larger context of an Identity Service response. These
|
||||
responses also provide a catalog of the various OpenStack
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter [
|
||||
<!ENTITY % openstack SYSTEM "../common/entities/openstack.ent">
|
||||
<!ENTITY % openstack SYSTEM "openstack.ent">
|
||||
%openstack;
|
||||
]>
|
||||
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter [
|
||||
<!ENTITY % openstack SYSTEM "../common/entities/openstack.ent">
|
||||
<!ENTITY % openstack SYSTEM "openstack.ent">
|
||||
%openstack;
|
||||
]>
|
||||
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter [
|
||||
<!ENTITY % openstack SYSTEM "../common/entities/openstack.ent">
|
||||
<!ENTITY % openstack SYSTEM "openstack.ent">
|
||||
%openstack;
|
||||
]>
|
||||
<chapter xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
|
||||
7862
security-guide/glossary-terms.xml
Normal file
7862
security-guide/glossary-terms.xml
Normal file
File diff suppressed because it is too large
Load Diff
12
security-guide/openstack.ent
Normal file
12
security-guide/openstack.ent
Normal file
@ -0,0 +1,12 @@
|
||||
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY nbsp " ">
|
||||
|
||||
<!ENTITY CHECK '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
||||
<imageobject>
|
||||
<imagedata fileref="static/Check_mark_23x20_02.svg"
|
||||
format="SVG" scale="60"/>
|
||||
</imageobject>
|
||||
</inlinemediaobject>'>
|
||||
@ -1,27 +1,30 @@
|
||||
<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">
|
||||
<parent>
|
||||
<groupId>org.openstack.docs</groupId>
|
||||
<artifactId>parent-pom</artifactId>
|
||||
<version>1.0.0-SNAPSHOT</version>
|
||||
<relativePath>../pom.xml</relativePath>
|
||||
</parent>
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>openstack-security-guide</artifactId>
|
||||
<groupId>org.openstack.docs</groupId>
|
||||
<version>1.0.0</version>
|
||||
<packaging>jar</packaging>
|
||||
<name>OpenStack Security Guide</name>
|
||||
|
||||
<properties>
|
||||
<!-- This is set by Jenkins according to the branch. -->
|
||||
<release.path.name>local</release.path.name>
|
||||
<comments.enabled>1</comments.enabled>
|
||||
</properties>
|
||||
|
||||
<!-- ################################################ -->
|
||||
<!-- USE "mvn clean generate-sources" to run this POM -->
|
||||
<!-- ################################################ -->
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>com.rackspace.cloud.api</groupId>
|
||||
<artifactId>clouddocs-maven-plugin</artifactId>
|
||||
<!-- version is set in ../pom.xml file -->
|
||||
<version>2.1.0</version>
|
||||
|
||||
<executions>
|
||||
<execution>
|
||||
<id>security-guide</id>
|
||||
@ -32,7 +35,7 @@
|
||||
<configuration>
|
||||
<includes>bk-openstack-sec-guide.xml</includes>
|
||||
<sourceDirectory>.</sourceDirectory>
|
||||
<glossaryCollection>${basedir}/../glossary/glossary-terms.xml</glossaryCollection>
|
||||
<glossaryCollection>glossary-terms.xml</glossaryCollection>
|
||||
<webhelpDirname>security-guide</webhelpDirname>
|
||||
<pdfFilenameBase>security-guide</pdfFilenameBase>
|
||||
<enableDisqus>${comments.enabled}</enableDisqus>
|
||||
@ -72,4 +75,27 @@
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
<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>
|
||||
</project>
|
||||
|
||||
60
security-guide/static/Check_mark_23x20_02.svg
Normal file
60
security-guide/static/Check_mark_23x20_02.svg
Normal file
@ -0,0 +1,60 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://web.resource.org/cc/"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
width="19.21315"
|
||||
height="18.294994"
|
||||
id="svg2"
|
||||
sodipodi:version="0.32"
|
||||
inkscape:version="0.45"
|
||||
sodipodi:modified="true"
|
||||
version="1.0">
|
||||
<defs
|
||||
id="defs4" />
|
||||
<sodipodi:namedview
|
||||
id="base"
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#666666"
|
||||
borderopacity="1.0"
|
||||
gridtolerance="10000"
|
||||
guidetolerance="10"
|
||||
objecttolerance="10"
|
||||
inkscape:pageopacity="0.0"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:zoom="7.9195959"
|
||||
inkscape:cx="17.757032"
|
||||
inkscape:cy="7.298821"
|
||||
inkscape:document-units="px"
|
||||
inkscape:current-layer="layer1"
|
||||
inkscape:window-width="984"
|
||||
inkscape:window-height="852"
|
||||
inkscape:window-x="148"
|
||||
inkscape:window-y="66" />
|
||||
<metadata
|
||||
id="metadata7">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<g
|
||||
inkscape:label="Layer 1"
|
||||
inkscape:groupmode="layer"
|
||||
id="layer1"
|
||||
transform="translate(-192.905,-516.02064)">
|
||||
<path
|
||||
style="fill:#000000"
|
||||
d="M 197.67968,534.31563 C 197.40468,534.31208 196.21788,532.53719 195.04234,530.37143 L 192.905,526.43368 L 193.45901,525.87968 C 193.76371,525.57497 194.58269,525.32567 195.27896,525.32567 L 196.5449,525.32567 L 197.18129,527.33076 L 197.81768,529.33584 L 202.88215,523.79451 C 205.66761,520.74678 208.88522,517.75085 210.03239,517.13691 L 212.11815,516.02064 L 207.90871,520.80282 C 205.59351,523.43302 202.45735,527.55085 200.93947,529.95355 C 199.42159,532.35625 197.95468,534.31919 197.67968,534.31563 z "
|
||||
id="path2223" />
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 2.1 KiB |
Loading…
Reference in New Issue
Block a user