Skip to content

Commit 5094349

Browse files
Jessica Tomechakchipchilders
Jessica Tomechak
authored and
chipchilders
committed
Fix the docs builds for Admin, Developer's, and Installation guides. Remove unneeded files. Add new files. Reorganize chapter structure. Can also build all together with publican-all.cfg.
Conflicts: docs/en-US/added-API-commands.xml docs/en-US/user-services-overview.xml
1 parent 3854de4 commit 5094349

41 files changed

Lines changed: 672 additions & 617 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/en-US/API_Developers_Guide.xml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,13 @@
4545
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
4646
</bookinfo>
4747
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
48-
<xi:include href="developer-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
48+
<xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
49+
<xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
50+
<xi:include href="api-calls.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
51+
<xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
52+
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
53+
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
54+
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
4955
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5056
</book>
5157

‎docs/en-US/Admin_Guide.xml‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
<book>
2626
<bookinfo id="cloudstack_admin">
27-
<title>&PRODUCT; Admin Guide</title>
27+
<title>&PRODUCT; Administrator's Guide</title>
2828
<productname>Apache CloudStack</productname>
2929
<productnumber>4.0</productnumber>
3030
<edition>1</edition>
@@ -45,7 +45,30 @@
4545
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
4646
</bookinfo>
4747
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
48-
<xi:include href="admin-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
48+
<xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
49+
<xi:include href="accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
50+
<xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
51+
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
52+
<xi:include href="projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
53+
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
54+
<xi:include href="offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
55+
<xi:include href="set-up-network-for-users.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
56+
<xi:include href="virtual-machines.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
57+
<xi:include href="working-with-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
58+
<xi:include href="working-with-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
59+
<xi:include href="storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
60+
<xi:include href="work-with-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
61+
<xi:include href="networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
62+
<xi:include href="working-with-system-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
63+
<xi:include href="sys-reliability-and-ha.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
64+
<xi:include href="manage-cloud.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
65+
<xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
66+
<xi:include href="api-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
67+
<xi:include href="tuning.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
68+
<xi:include href="troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
69+
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
70+
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
71+
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
4972
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5073
</book>
5174

‎docs/en-US/Installation_Guide.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
<xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5050
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5151
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
52+
<xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5253
<xi:include href="hypervisor-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5354
<xi:include href="choosing-a-deployment-architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5455
<xi:include href="Revision_History_Install_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

‎docs/en-US/about-virtual-networks.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424

2525
<section id="about-virtual-networks">
2626
<title>About Virtual Networks</title>
27-
<para>A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT;, a virtual network can be shared or isolated.</para>
28-
<para><xref linkend="isolated-networks" />XenServer and Maintenance Mode</para>
29-
<para><xref linkend="shared-networks" />Working with Usage</para>
30-
<para><xref linkend="runtime-allocation-virtual-network-resources" />XenServer and Maintenance Mode</para>
31-
</section>
27+
<para>A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT; a virtual network can be shared or isolated.</para>
28+
<xi:include href="isolated-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
29+
<xi:include href="shared-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
30+
<xi:include href="runtime-allocation-virtual-network-resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
31+
</section>

‎docs/en-US/accounts.xml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@
2222
under the License.
2323
-->
2424

25-
<section id="accounts">
25+
<chapter id="accounts">
2626
<title>Accounts</title>
2727
<xi:include href="accounts-users-domains.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
2828
<xi:include href="LDAPserver-for-user-authentication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
29-
30-
</section>
29+
</chapter>

‎docs/en-US/added-API-commands.xml‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
-->
2121
<section id="added-API-commands">
2222
<title>Added API commands</title>
23-
<para>Added in 4.0</para>
23+
<section id="added-API-commands-4.0">
24+
<title>Added in 4.0</title>
2425
<itemizedlist>
2526
<listitem>
2627
<para>createCounter (Adds metric counter)</para>
@@ -149,23 +150,29 @@
149150
<para>listVpnConnections (Lists site to site vpn connection gateways)</para>
150151
</listitem>
151152
</itemizedlist>
152-
<para>Added in 3.0.2:</para>
153+
</section>
154+
<section id="added-api-commands-3.0.2">
155+
<title>Added in 3.0.2</title>
153156
<itemizedlist>
154157
<listitem>
155158
<para>changeServiceForSystemVm</para>
156159
<para>Changes the service offering for a system VM (console proxy or secondary storage). The
157160
system VM must be in a "Stopped" state for this command to take effect.</para>
158161
</listitem>
159162
</itemizedlist>
160-
<para>Added in 3.0.1:</para>
163+
</section>
164+
<section id="added-api-commands-3.0.1">
165+
<title>Added in 3.0.1</title>
161166
<itemizedlist>
162167
<listitem>
163168
<para>changeServiceForSystemVm</para>
164169
<para>Changes the service offering for a system VM (console proxy or secondary storage). The
165170
system VM must be in a "Stopped" state for this command to take effect.</para>
166171
</listitem>
167172
</itemizedlist>
168-
<para>Added in 3.0.0:</para>
173+
</section>
174+
<section id="added-api-commands-3.0.0">
175+
<title>Added in 3.0.0</title>
169176
<informaltable frame="all">
170177
<tgroup cols="3" align="left" colsep="1" rowsep="1">
171178
<colspec colname="c1"/>
@@ -315,4 +322,5 @@
315322
</tbody>
316323
</tgroup>
317324
</informaltable>
325+
</section>
318326
</section>

‎docs/en-US/alerts.xml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
16
<!-- Licensed to the Apache Software Foundation (ASF) under one
27
or more contributor license agreements. See the NOTICE file
38
distributed with this work for additional information
@@ -16,8 +21,8 @@
1621
under the License.
1722
-->
1823

19-
<section id="alerts">
20-
<title>Alerts</title>
24+
<appendix id="alerts">
25+
<title>Alerts</title>
2126
<para>The following is the list of alert type numbers. The current alerts can be found by calling listAlerts.</para>
2227
<programlisting>MEMORY = 0</programlisting>
2328
<programlisting>CPU = 1</programlisting>
@@ -45,5 +50,4 @@
4550
<programlisting>DIRECT_ATTACHED_PUBLIC_IP = 23;</programlisting>
4651
<programlisting>LOCAL_STORAGE = 24;</programlisting>
4752
<programlisting>RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only</programlisting>
48-
</section>
49-
53+
</appendix>

docs/en-US/developer-guide.xml renamed to docs/en-US/api-calls.xml

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,11 @@
2222
under the License.
2323
-->
2424

25-
<chapter id="developer-guide">
26-
<title>Using the API</title>
27-
<xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
28-
<xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
25+
<chapter id="api-calls">
26+
<title>Calling the &PRODUCT; API</title>
2927
<xi:include href="making-api-request.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
3028
<xi:include href="enabling-api-call-expiration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
3129
<xi:include href="signing-api-requests.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
3230
<xi:include href="responses.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
3331
<xi:include href="asynchronous-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
34-
<xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
35-
<xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
36-
<xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
37-
<xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
3832
</chapter>

‎docs/en-US/appendix-a-time-zones.xml‎

Lines changed: 0 additions & 143 deletions
This file was deleted.

0 commit comments

Comments
 (0)