From 006cafd5a213fdf651f284a8f4ce71b90a6935a0 Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Wed, 2 Apr 2014 16:06:55 -0500 Subject: [PATCH] Rework to add PDF for complete API reference pages Add link for comprehensive API Reference PDF to all index.html pages Partial-Bug: #1301473 Change-Id: I9ac759e0a26d64c1060a0ff1fc1a00565416fa2c author: diane fleming --- .../compute/section_compute-image-mgt.xml | 134 ++--- doc/common/app_support.xml | 490 ++++++++++-------- www/api/api-ref-guides.html | 6 +- www/havana/index.html | 6 +- www/index.html | 10 +- www/trunk/index.html | 6 +- 6 files changed, 356 insertions(+), 296 deletions(-) diff --git a/doc/admin-guide-cloud/compute/section_compute-image-mgt.xml b/doc/admin-guide-cloud/compute/section_compute-image-mgt.xml index 2b884f33e1..944745b091 100644 --- a/doc/admin-guide-cloud/compute/section_compute-image-mgt.xml +++ b/doc/admin-guide-cloud/compute/section_compute-image-mgt.xml @@ -2,68 +2,74 @@
+ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> Image management - The OpenStack Image Service discovers, registers, and retrieves virtual machine images. - The service also includes a RESTful API that allows you to query VM image metadata and - retrieve the actual image with HTTP requests. For more information about the API, see the - OpenStack - API or the Python - API. - The OpenStack Image Service can be controlled using a command-line tool. For more - information about the using OpenStack Image command-line tool, see the Manage - Images section in the OpenStack End User Guide. - Virtual images that have been made available through the Image Service can be stored - in a variety of ways. In order to use these services, you must have a working installation - of the Image Service, with a working endpoint, and users that have been created in OpenStack - Identity. Additionally, you must meet the environment variables required by the Compute and - Image Service clients. - The Image Service supports these back end stores: - - - File system - - The OpenStack Image Service stores virtual machine images in the file - system back end by default. This simple back end writes image files to the local - file system. - - - - Object Storage service - - The OpenStack highly available service for storing objects. - - - - S3 - - The Amazon S3 service. - - - - HTTP - - OpenStack Image Service can read virtual - machine images that are available on the - internet using HTTP. This store is read - only. - - - - Rados block device (RBD) - - Stores images inside of a Ceph storage - cluster using Ceph's RBD interface. - - - - GridFS - - Stores images using MongoDB. - - - -
\ No newline at end of file + The OpenStack Image Service discovers, registers, and + retrieves virtual machine images. The service also includes a + RESTful API that allows you to query VM image metadata and + retrieve the actual image with HTTP requests. For more + information about the API, see the OpenStack API Complete Reference and the Python API. + The OpenStack Image Service can be controlled using a + command-line tool. For more information about the using + OpenStack Image command-line tool, see the Manage Images section in the OpenStack + End User Guide. + Virtual images that have been made available through the + Image Service can be stored in a variety of ways. In order to + use these services, you must have a working installation of + the Image Service, with a working endpoint, and users that + have been created in OpenStack Identity. Additionally, you + must meet the environment variables required by the Compute + and Image Service clients. + The Image Service supports these back-end stores: + + + File system + + The OpenStack Image Service stores virtual + machine images in the file system back end by + default. This simple back end writes image files + to the local file system. + + + + Object Storage service + + The OpenStack highly available service for + storing objects. + + + + S3 + + The Amazon S3 service. + + + + HTTP + + OpenStack Image Service can read virtual machine + images that are available on the internet using + HTTP. This store is read only. + + + + Rados block device (RBD) + + Stores images inside of a Ceph storage cluster + using Ceph's RBD interface. + + + + GridFS + + Stores images using MongoDB. + + + + diff --git a/doc/common/app_support.xml b/doc/common/app_support.xml index 55e343ca76..4dbdd2398b 100644 --- a/doc/common/app_support.xml +++ b/doc/common/app_support.xml @@ -5,7 +5,6 @@ xml:id="app_community_support"> Community support - Many resources are available to help you run and use OpenStack. Members of the OpenStack community can answer questions and help with bug suspicions. We are constantly @@ -13,12 +12,11 @@ you have any problems, do not hesitate to ask. Use the following resources to get OpenStack support and troubleshoot your existing installations. -
Documentation For the available OpenStack documentation, see docs.openstack.org. + xlink:href="http://docs.openstack.org" + >docs.openstack.org. To provide feedback on documentation, join and use the openstack-docs@lists.openstack.org mailing list at OpenStack Documentation Mailing List, or report a bug. - - The following books explain how to install an OpenStack cloud - and its associated components: - + The following books explain how to install an OpenStack + cloud and its associated components: - - - - Installation Guide for Debian 7.0 - - - - - - - Installation Guide for openSUSE and SUSE Linux Enterprise Server - - - - - - - Installation Guide for Red Hat Enterprise Linux, - CentOS, and Fedora - - - - - - - Installation Guide for Ubuntu 12.04 (LTS) - - - + + + + Installation Guide for Debian + 7.0 + + + + + + Installation Guide for openSUSE and + SUSE Linux Enterprise Server + + + + + + Installation Guide for Red Hat + Enterprise Linux, CentOS, and + Fedora + + + + + + Installation Guide for Ubuntu 12.04 + (LTS) + + The following books explain how to configure and run an - OpenStack cloud: + OpenStack cloud: - - - Cloud Administrator Guide - - - - Configuration Reference - - - - Operations Guide - - - High Availability Guide - - - - Security Guide - - - - Virtual Machine Image Guide - - + + + Cloud Administrator + Guide + + + Configuration + Reference + + + Operations + Guide + + + High Availability + Guide + + + Security + Guide + + + Virtual Machine Image + Guide + The following books explain how to use the OpenStack dashboard and command-line clients: - - - API Quick Start - - - - - End User Guide - - - - - Admin User Guide - - - - - Command-Line Interface - Reference - - + + + API Quick + Start + + + + End User + Guide + + + + Admin User + Guide + + + + Command-Line Interface + Reference + The following documentation provides reference and guidance information for the OpenStack APIs: - OpenStack API Reference + + + OpenStack API Complete + Reference (HTML) + + + API Complete Reference (PDF) + OpenStack Compute API v2 and Extensions Reference + xlink:href="http://docs.openstack.org/api/openstack-compute/2/content/" + >OpenStack Compute API v2 and + Extensions + Reference OpenStack Identity Service API v2.0 Reference + xlink:href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/" + >OpenStack Identity Service API + v2.0 Reference OpenStack Image Service API v2 Reference + xlink:href="http://docs.openstack.org/api/openstack-image-service/2.0/content/" + >OpenStack Image Service API v2 + Reference OpenStack Networking API v2.0 Reference + xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/" + >OpenStack Networking API v2.0 + Reference OpenStack Object Storage API v1 Reference - - The Training Guides - offer software training for cloud administration and management. + xlink:href="http://docs.openstack.org/api/openstack-object-storage/1.0/content/" + >OpenStack Object Storage API + v1 Reference + + + The Training Guides + offer software training for cloud administration and + management.
-
ask.openstack.org - During the set up or testing of OpenStack, you might have questions about -how a specific task is completed or be in a situation where a feature -does not work correctly. Use the ask.openstack.org site to ask questions and -get answers. When you visit the http://ask.openstack.org site, scan the recently asked questions to see whether -your question has already been answered. If not, ask a new question. Be sure -to give a clear, concise summary in the title and provide -as much detail as possible in the description. Paste in -your command output or stack traces, links to screen shots, -and so on. + During the set up or testing of OpenStack, you might + have questions about how a specific task is completed or + be in a situation where a feature does not work correctly. + Use the ask.openstack.org site to ask questions and + get answers. When you visit the http://ask.openstack.org site, scan the + recently asked questions to see whether your question has + already been answered. If not, ask a new question. Be sure + to give a clear, concise summary in the title and provide + as much detail as possible in the description. Paste in + your command output or stack traces, links to screen + shots, and so on.
OpenStack mailing lists A great way to get answers and insights is to post your - question or problematic scenario to the OpenStack mailing list. You - can learn from and help others who might have similar - issues. To subscribe or view the archives, go to + question or problematic scenario to the OpenStack mailing + list. You can learn from and help others who might have + similar issues. To subscribe or view the archives, go to http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack. @@ -210,21 +230,21 @@ and so on.
The OpenStack wiki The OpenStack wiki contains a broad - range of topics but some of the information can be difficult - to find or is a few pages deep. Fortunately, the wiki search + >OpenStack wiki contains a broad range of + topics but some of the information can be difficult to + find or is a few pages deep. Fortunately, the wiki search feature enables you to search by title or content. If you - search for specific information, such as about networking or - nova, you can find lots of relevant material. More is being - added all the time, so be sure to check back often. You can find - the search box in the upper right corner of any OpenStack wiki - page. + search for specific information, such as about networking + or nova, you can find lots of relevant material. More is + being added all the time, so be sure to check back often. + You can find the search box in the upper right corner of + any OpenStack wiki page.
The Launchpad Bugs area - The OpenStack community values your set - up and testing efforts and wants your feedback. To log a - bug, you must sign up for a Launchpad account at The OpenStack community values your set up and testing + efforts and wants your feedback. To log a bug, you must + sign up for a Launchpad account at https://launchpad.net/+login. You can view existing bugs and report bugs in the Launchpad Bugs area. @@ -234,79 +254,100 @@ and so on. report. Some tips: - - Give a clear, concise summary! - - - Provide as much detail as possible in the - description. Paste in your command output or stack - traces, links to screen shots, and so on. - - - Be sure to include the software and package versions that you are using, - especially if you are using a development branch, - such as, "Grizzly release" vs git commit + + Give a clear, concise summary! + + + Provide as much detail as possible in the + description. Paste in your command output or stack + traces, links to screen shots, and so on. + + + Be sure to include the software and package + versions that you are using, especially if you are + using a development branch, such as, + "Grizzly release" vs git commit bc79c3ecc55929bac585d04a03475b72e06a3208. - - - Any deployment specific information is helpful, - such as Ubuntu 12.04 or multi-node install. - + + + Any deployment specific information is helpful, + such as Ubuntu 12.04 or multi-node install. + The Launchpad Bugs areas are available here: - Bugs: - OpenStack Block Storage (cinder) + Bugs: OpenStack Block Storage + (cinder) - Bugs: - OpenStack Compute (nova) + Bugs: OpenStack Compute (nova) - Bugs: - OpenStack Dashboard (horizon) + Bugs: OpenStack Dashboard + (horizon) - Bugs: OpenStack Identity (keystone) + Bugs: OpenStack Identity + (keystone) - Bugs: - OpenStack Image Service (glance) + Bugs: OpenStack Image Service + (glance) - Bugs: - OpenStack Networking (neutron) + Bugs: OpenStack Networking + (neutron) - Bugs: - OpenStack Object Storage (swift) + Bugs: OpenStack Object Storage + (swift) - Bugs: Bare Metal (ironic) - Bugs: Data Processing Service (sahara) + Bugs: Data Processing Service + (sahara) - Bugs: Database Service (trove) - Bugs: - Orchestration (heat) + Bugs: Orchestration (heat) - Bugs: Telemetry (ceilometer) - Bugs: Queue Service (marconi) @@ -352,49 +393,46 @@ and so on. >https://wiki.openstack.org/wiki/IRC.
- Documentation feedback + Documentation feedback To provide feedback on documentation, join and use the - openstack-docs@lists.openstack.org - mailing list at OpenStack Documentation Mailing List, - or report a bug. - + openstack-docs@lists.openstack.org + mailing list at OpenStack Documentation Mailing List, or report a bug.
-
- OpenStack distribution packages - - The following Linux distributions provide community-supported packages for - OpenStack: - - - - Debian: http://wiki.debian.org/OpenStack - - - CentOS, Fedora, and Red Hat - Enterprise Linux: http://openstack.redhat.com/ - - - - openSUSE and SUSE Linux - Enterprise Server: - http://en.opensuse.org/Portal:OpenStack - - - - Ubuntu: - https://wiki.ubuntu.com/ServerTeam/CloudArchive - - - + OpenStack distribution packages + The following Linux distributions provide + community-supported packages for OpenStack: + + + Debian: + http://wiki.debian.org/OpenStack + + + CentOS, Fedora, and Red + Hat Enterprise Linux: + http://openstack.redhat.com/ + + + openSUSE and SUSE Linux + Enterprise Server: + http://en.opensuse.org/Portal:OpenStack + + + Ubuntu: + https://wiki.ubuntu.com/ServerTeam/CloudArchive + +
- + diff --git a/www/api/api-ref-guides.html b/www/api/api-ref-guides.html index 358506e2d7..c621628903 100755 --- a/www/api/api-ref-guides.html +++ b/www/api/api-ref-guides.html @@ -101,7 +101,11 @@ div.c1 {width: 100%;}
API Complete Reference + >API Complete Reference (HTML) +
+
API Complete Reference (PDF)
API Complete Reference + >API Complete Reference (HTML) +
+
API Complete Reference (PDF)
Virtual Machine Image Guide
-

Training Guides

+

Training guides

- Training Guides + Training guides

Get involved

@@ -258,7 +258,11 @@
API Complete Reference + >API Complete Reference (HTML) +
+
API Complete Reference (PDF)
API Complete Reference + >API Complete Reference (HTML) +
+
API Complete Reference (PDF)