Skip to content

Commit

Permalink
initial commit of new layout/consolidated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Angus committed Jul 27, 2018
0 parents commit 7085861
Show file tree
Hide file tree
Showing 572 changed files with 218,306 additions and 0 deletions.
20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = ApacheCloudStack
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
36 changes: 36 additions & 0 deletions make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=ApacheCloudStack

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
rd %BUILDDIR% /q /s
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd
46 changes: 46 additions & 0 deletions source/_global.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information#
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
.. This file contain Variables shared across other .rst files in this project
.. _CloudStack Installation Guide: http://docs.cloudstack.apache.org/projects/cloudstack-installation
.. _CloudStack Administrator's Guide: http://docs.cloudstack.apache.org/projects/cloudstack-administration
.. _CloudStack Apidocs: http://cloudstack.apache.org/docs/api/

.. |documentation_home| replace:: http://docs.cloudstack.apache.org/

.. Latest version systemvm template URL
.. |sysvm64-url-xen| replace:: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-xen.vhd.bz2
.. |sysvm64-url-kvm| replace:: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-kvm.qcow2.bz2
.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-vmware.ova
.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-hyperv.vhd.zip
.. |sysvm64-url-ovm| replace:: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-ovm.raw.bz2

.. Version specific: 4.5 systemvm template URL
.. |acs45-sysvm64-url-xen| replace:: http://download.cloudstack.org/systemvm/4.5/systemvm64template-4.5-xen.vhd.bz2
.. |acs45-sysvm64-url-kvm| replace:: http://download.cloudstack.org/systemvm/4.5/systemvm64template-4.5-kvm.qcow2.bz2
.. |acs45-sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.5/systemvm64template-4.5-vmware.ova
.. |acs45-sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.5/systemvm64template-4.5-hyperv.vhd.zip

.. Images
.. |vpn-icon.png| image:: /_static/images/vpn-icon.png
.. |sysmanager.png| image:: /_static/images/sysmanager.png
.. |software-license.png| image:: /_static/images/software-license.png
.. |change-admin-password.png| image:: /_static/images/change-admin-password.png
.. |menu_acs_logo| image:: /_static/acslogo.png
Binary file added source/_static/acslogo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/1000-foot-view.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/60recipe.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/CloudStack-ldap-screen1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/DevCloud-hostonly.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/DevCloud.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/SnapshotButton.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/VMSnapshotButton.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/acslogo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-cifs.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-cluster.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-gateway.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-gslb.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-guest-network.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-ip-range.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-new-gateway-vpc.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-tier.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-vlan-icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-vm-vpc.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/add-vpc.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/addAccount-icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/addvm-tier-sharednw.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_static/images/attach-disk-icon.png
Binary file added source/_static/images/autoscale-config.png
Binary file added source/_static/images/basic-deployment.png
Binary file added source/_static/images/change-admin-password.png
Binary file added source/_static/images/change-affinity-button.png
Binary file added source/_static/images/change-password.png
Binary file added source/_static/images/change-service-icon.png
Binary file added source/_static/images/cifs-primary.png
Binary file added source/_static/images/cifs-ss.png
Binary file added source/_static/images/cloudian-s3_ss_cache.png
Binary file added source/_static/images/cloudian-ss_globalopt.png
Binary file added source/_static/images/cloudian-tab.png
Binary file added source/_static/images/cluster-overview.png
Binary file added source/_static/images/console-icon.png
Binary file added source/_static/images/create-vpn-connection.png
Binary file added source/_static/images/del-tier.png
Binary file added source/_static/images/delete-button.png
Binary file added source/_static/images/destroy-instance.png
Binary file added source/_static/images/detach-disk-icon.png
Binary file added source/_static/images/dvswitch-config.png
Binary file added source/_static/images/dvswitchconfig.png
Binary file added source/_static/images/ec2-s3-configuration.png
Binary file added source/_static/images/edit-icon.png
Binary file added source/_static/images/edit-traffic-type.png
Binary file added source/_static/images/egress-firewall-rule.png
Binary file added source/_static/images/eip-ns-basiczone.png
Binary file added source/_static/images/enable-disable-autoscale.png
Binary file added source/_static/images/enable-disable.png
Binary file added source/_static/images/gslb.png
Binary file added source/_static/images/guest-traffic-setup.png
Binary file added source/_static/images/http-access.png
Binary file added source/_static/images/hypervisorcomms.png
37 changes: 37 additions & 0 deletions source/_static/images/icon.svg
Binary file added source/_static/images/infrastructure-overview.png
Binary file added source/_static/images/installation-complete.png
Binary file added source/_static/images/iso-icon.png
Binary file added source/_static/images/jp1.jpg
Binary file added source/_static/images/jp2.jpg
Binary file added source/_static/images/ldap-config.png
Binary file added source/_static/images/metric-view.png
Binary file added source/_static/images/migrate-instance.png
Binary file added source/_static/images/monkey.png
Binary file added source/_static/images/multi-site-deployment.png
Binary file added source/_static/images/multi-tier-app.png
Binary file added source/_static/images/network-acl.png
Binary file added source/_static/images/network-setup-zone.png
Binary file added source/_static/images/network-singlepod.png
Binary file added source/_static/images/networking-egress-rule.png
Binary file added source/_static/images/networking-in-a-pod.png
Binary file added source/_static/images/networking-in-a-zone.png
Binary file added source/_static/images/networking-ingress-rule.png
Binary file added source/_static/images/nuage_iso_net_off.png
Binary file added source/_static/images/nuage_kvm_traffic_label.jpg
Binary file added source/_static/images/nuage_sha_net_off.png
Binary file added source/_static/images/nuage_vpc_net_off.png
Binary file added source/_static/images/nuage_vpc_off.png
Binary file added source/_static/images/nuage_vsd_device_add.png
Binary file added source/_static/images/nuage_vsp_nsp_enable.png
Binary file added source/_static/images/nuage_vsp_nsp_status.png
Binary file added source/_static/images/nuage_vsp_vpc_off.png
Binary file added source/_static/images/nvp-add-controller.png
Binary file added source/_static/images/nvp-enable-provider.png
Binary file added source/_static/images/nvp-network-offering.png
Binary file added source/_static/images/nvp-vpc-offering-edit.png
Binary file added source/_static/images/ovs-network-offering.png
Binary file added source/_static/images/packt.png
Binary file added source/_static/images/parallel-mode.png
Binary file added source/_static/images/plugin1.jpg
Binary file added source/_static/images/plugin2.jpg
Binary file added source/_static/images/plugin3.jpg
Binary file added source/_static/images/plugin4.jpg
Binary file added source/_static/images/plugin_intro.jpg
Binary file added source/_static/images/pod-overview.png
Binary file added source/_static/images/provisioning-overview.png
Binary file added source/_static/images/region-overview.png
Binary file added source/_static/images/release-ip-icon.png
Binary file added source/_static/images/remove-nic.png
Binary file added source/_static/images/remove-tier.png
Binary file added source/_static/images/remove-vpc.png
Binary file added source/_static/images/remove-vpn.png
Binary file added source/_static/images/replace-acl-icon.png
Binary file added source/_static/images/replace-acl-list.png
Binary file added source/_static/images/reset-vpn.png
Binary file added source/_static/images/resize-volume-icon.png
Binary file added source/_static/images/resize-volume.png
Binary file added source/_static/images/restart-vpc.png
Binary file added source/_static/images/revert-vm.png
Binary file added source/_static/images/s3-ss.png
Binary file added source/_static/images/search-button.png
Binary file added source/_static/images/select-vm-staticnat-vpc.png
Binary file added source/_static/images/set-default-nic.png
Binary file added source/_static/images/small-scale-deployment.png
Binary file added source/_static/images/software-license.png
Binary file added source/_static/images/stop-instance-icon.png
Binary file added source/_static/images/subnetting_storage.png
Binary file added source/_static/images/suspend-icon.png
Binary file added source/_static/images/sysmanager.png
Binary file added source/_static/images/traffic-type.png
Binary file added source/_static/images/update-ssl-icon.png
Binary file added source/_static/images/update-ssl.png
Binary file added source/_static/images/vds-name.png
Binary file added source/_static/images/view-console-button.png
Binary file added source/_static/images/view-systemvm-details.png
Binary file added source/_static/images/vm-lifecycle.png
Binary file added source/_static/images/vmware-increase-ports.png
Binary file added source/_static/images/vmware-iscsi-datastore.png
Binary file added source/_static/images/vmware-iscsi-general.png
Binary file added source/_static/images/vmware-iscsi-initiator.png
Binary file added source/_static/images/vmware-iscsi-target-add.png
Binary file added source/_static/images/vpc-lb.png
Binary file added source/_static/images/vpc-setting.png
Binary file added source/_static/images/vpn-icon.png
Binary file added source/_static/images/vpn/osxvpn_connected.png
Binary file added source/_static/images/vpn/osxvpn_form1.png
Binary file added source/_static/images/vpn/osxvpn_form2.png
Binary file added source/_static/images/vpn/osxvpn_form3.png
Binary file added source/_static/images/vpn/osxvpn_netconf.png
Binary file added source/_static/images/vpn/win1.png
Binary file added source/_static/images/vpn/win10.png
Binary file added source/_static/images/vpn/win11.png
Binary file added source/_static/images/vpn/win12.png
Binary file added source/_static/images/vpn/win13.png
Binary file added source/_static/images/vpn/win14.png
Binary file added source/_static/images/vpn/win2.png
Binary file added source/_static/images/vpn/win3.png
Binary file added source/_static/images/vpn/win4.png
Binary file added source/_static/images/vpn/win5.png
Binary file added source/_static/images/vpn/win6.png
Binary file added source/_static/images/vpn/win7.png
Binary file added source/_static/images/vpn/win8.png
Binary file added source/_static/images/vpn/win9.png
Binary file added source/_static/images/vr-upgrade.png
Binary file added source/_static/images/vsphere-client.png
Binary file added source/_static/images/vxlan-physicalnetwork.png
Binary file added source/_static/images/vxlan-trafficlabel.png
Binary file added source/_static/images/vxlan-vniconfig.png
Binary file added source/_static/images/workloads.png
Binary file added source/_static/images/zone-overview.png
18 changes: 18 additions & 0 deletions source/_static/theme_overrides.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/* override nav-search background */

/* override table width restrictions */
.wy-table-responsive table td, .wy-table-responsive table th {
white-space: normal;
}

.wy-table-responsive {
margin-bottom: 24px;
max-width: 100%;
overflow: visible;
}

/*
div[class^="highlight"] pre {
font-size:10px
}
*/

0 comments on commit 7085861

Please sign in to comment.