From 96ae8ec0c4e3d8d4ca76cde9175a8148a3ed8333 Mon Sep 17 00:00:00 2001 From: Olena Logvinova Date: Fri, 30 Sep 2016 17:40:33 +0300 Subject: [PATCH] [common] [Newton] Updating links for Newton This patch: - updates the links for Newton in the /common folder - removes a commented non-publishing command for Debian Install guide from publishdocs.sh. (If the Guide is still not ready for Newton, we will re-add this command back and remove the guide from www/project-install-guide/newton/index.html) - removes old link for API reference and uses API Guide instead. Change-Id: Ib7be38419deadaa8ff70256e12111e1c9a7fe143 --- doc/common/app-support.rst | 27 ++++++++++--------- doc/common/cli-manage-images.rst | 2 +- doc/common/get-started-compute.rst | 2 +- .../get-started-shared-file-systems.rst | 2 +- doc/common/get-started-with-openstack.rst | 22 +++++++-------- tools/publishdocs.sh | 2 -- 6 files changed, 29 insertions(+), 28 deletions(-) diff --git a/doc/common/app-support.rst b/doc/common/app-support.rst index c96cbc57af..ab1bce56a9 100644 --- a/doc/common/app-support.rst +++ b/doc/common/app-support.rst @@ -31,15 +31,21 @@ bug `__. The following books explain how to install an OpenStack cloud and its associated components: -* `Installation Guide for openSUSE Leap 42.1 and SUSE Linux Enterprise +* `Installation Tutorial for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1 - `__ + `__ -* `Installation Guide for Red Hat Enterprise Linux 7 and CentOS 7 - `__ +* `Installation Tutorial for Red Hat Enterprise Linux 7 and CentOS 7 + `__ -* `Installation Guide for Ubuntu 14.04 (LTS) - `__ +* `Installation Tutorial for Ubuntu 16.04 (LTS) + `__ + +* `Installation Tutorial For Debian With Debconf + `__ + +* `Installation Tutorial For Debian + `__ The following books explain how to configure and run an OpenStack cloud: @@ -47,11 +53,11 @@ The following books explain how to configure and run an OpenStack cloud: * `Administrator Guide `__ -* `Configuration Reference `__ +* `Configuration Reference `__ * `Operations Guide `__ -* `Networking Guide `__ +* `Networking Guide `__ * `High Availability Guide `__ @@ -62,8 +68,6 @@ The following books explain how to configure and run an OpenStack cloud: The following books explain how to use the OpenStack dashboard and command-line clients: -* `API Guide `__ - * `End User Guide `__ * `Command-Line Interface Reference @@ -72,8 +76,7 @@ command-line clients: The following documentation provides reference and guidance information for the OpenStack APIs: -* `API Complete Reference - (HTML) `__ +* `API Guide `__ The following guide provides how to contribute to OpenStack documentation: diff --git a/doc/common/cli-manage-images.rst b/doc/common/cli-manage-images.rst index 05152b872b..d5dc7423e7 100644 --- a/doc/common/cli-manage-images.rst +++ b/doc/common/cli-manage-images.rst @@ -206,7 +206,7 @@ model: :command:`glance image-create`. Also, we recommend that you set the ``hypervisor_type="vmware"`` property. For more information, see `Images with VMware vSphere - `_ + `_ in the OpenStack Configuration Reference. .. code-block:: console diff --git a/doc/common/get-started-compute.rst b/doc/common/get-started-compute.rst index d2149fc446..ad2b951ea3 100644 --- a/doc/common/get-started-compute.rst +++ b/doc/common/get-started-compute.rst @@ -54,7 +54,7 @@ OpenStack Compute consists of the following areas and their components: by the ``nova-compute`` service. The ``nova-conductor`` module scales horizontally. However, do not deploy it on nodes where the ``nova-compute`` service runs. For more information, see `Configuration - Reference Guide `__. + Reference Guide `__. ``nova-cert`` module A server daemon that serves the Nova Cert service for X509 diff --git a/doc/common/get-started-shared-file-systems.rst b/doc/common/get-started-shared-file-systems.rst index 1079851e7c..76af327031 100644 --- a/doc/common/get-started-shared-file-systems.rst +++ b/doc/common/get-started-shared-file-systems.rst @@ -35,4 +35,4 @@ manila-share Messaging queue Routes information between the Shared File Systems processes. -For more information, see `Configuration Reference Guide `__. +For more information, see `OpenStack Configuration Reference `__. diff --git a/doc/common/get-started-with-openstack.rst b/doc/common/get-started-with-openstack.rst index 82f07e28e1..62452dcbdd 100644 --- a/doc/common/get-started-with-openstack.rst +++ b/doc/common/get-started-with-openstack.rst @@ -31,23 +31,23 @@ OpenStack architecture: * - Service - Project name - Description - * - `Dashboard `__ + * - `Dashboard `__ - `Horizon `__ - Provides a web-based self-service portal to interact with underlying OpenStack services, such as launching an instance, assigning IP addresses and configuring access controls. - * - `Compute `__ + * - `Compute `__ - `Nova `__ - Manages the lifecycle of compute instances in an OpenStack environment. Responsibilities include spawning, scheduling and decommissioning of virtual machines on demand. - * - `Networking `__ + * - `Networking `__ - `Neutron `__ - Enables Network-Connectivity-as-a-Service for other OpenStack services, such as OpenStack Compute. Provides an API for users to define networks and the attachments into them. Has a pluggable architecture that supports many popular networking vendors and technologies. - * - `Object Storage `__ + * - `Object Storage `__ - `Swift `__ - Stores and retrieves arbitrary unstructured data objects via a RESTful, HTTP based API. It is highly fault tolerant with its data replication @@ -55,35 +55,35 @@ OpenStack architecture: with mountable directories. In this case, it writes objects and files to multiple drives, ensuring the data is replicated across a server cluster. - * - `Block Storage `__ + * - `Block Storage `__ - `Cinder `__ - Provides persistent block storage to running instances. Its pluggable driver architecture facilitates the creation and management of block storage devices. - * - `Identity service `__ + * - `Identity service `__ - `Keystone `__ - Provides an authentication and authorization service for other OpenStack services. Provides a catalog of endpoints for all OpenStack services. - * - `Image service `__ + * - `Image service `__ - `Glance `__ - Stores and retrieves virtual machine disk images. OpenStack Compute makes use of this during instance provisioning. - * - `Telemetry `__ + * - `Telemetry `__ - `Ceilometer `__ - Monitors and meters the OpenStack cloud for billing, benchmarking, scalability, and statistical purposes. - * - `Orchestration `__ + * - `Orchestration `__ - `Heat `__ - Orchestrates multiple composite cloud applications by using either the native HOT template format or the AWS CloudFormation template format, through both an OpenStack-native REST API and a CloudFormation-compatible Query API. - * - `Database service `__ + * - `Database service `__ - `Trove `__ - Provides scalable and reliable Cloud Database-as-a-Service functionality for both relational and non-relational database engines. - * - `Data processing service `__ + * - `Data processing service `__ - `Sahara `__ - Provides capabilities to provision and scale Hadoop clusters in OpenStack by specifying parameters like Hadoop version, cluster topology and nodes diff --git a/tools/publishdocs.sh b/tools/publishdocs.sh index 7ffdf4d5c4..5c0b28e1dd 100755 --- a/tools/publishdocs.sh +++ b/tools/publishdocs.sh @@ -41,8 +41,6 @@ function copy_to_branch { for f in $(find publish-docs/$BRANCH -name "*.html"); do sed -i -e "s|/draft/|/$BRANCH/|g" $f done - # Debian Install Guide for Newton is not ready - rm -rf publish-docs/$BRANCH/install-guide-debian fi }