openstack
/
openstack-manuals
Code Issues Proposed changes

[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
This commit is contained in:
Olena Logvinova 2016-09-30 17:40:33 +03:00 committed by Andreas Jaeger
parent ceeb57d21d
commit 96ae8ec0c4
6 changed files with 29 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/common/app-support.rst
View File

@ -31,15 +31,21 @@ bug <https://bugs.launchpad.net/openstack-manuals/+filebug>`__.
The following books explain how to install an OpenStack cloud and its The following books explain how to install an OpenStack cloud and its
associated components: 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 Server 12 SP1
<http://docs.openstack.org/mitaka/install-guide-obs/>`__ <http://docs.openstack.org/newton/install-guide-obs/>`__
* `Installation Guide for Red Hat Enterprise Linux 7 and CentOS 7 * `Installation Tutorial for Red Hat Enterprise Linux 7 and CentOS 7
<http://docs.openstack.org/mitaka/install-guide-rdo/>`__ <http://docs.openstack.org/newton/install-guide-rdo/>`__
* `Installation Guide for Ubuntu 14.04 (LTS) * `Installation Tutorial for Ubuntu 16.04 (LTS)
<http://docs.openstack.org/mitaka/install-guide-ubuntu/>`__ <http://docs.openstack.org/newton/install-guide-ubuntu/>`__
* `Installation Tutorial For Debian With Debconf
<http://docs.openstack.org/newton/install-guide-debconf/>`__
* `Installation Tutorial For Debian
<http://docs.openstack.org/newton/install-guide-debian/>`__
The following books explain how to configure and run an OpenStack cloud: 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 <http://docs.openstack.org/admin-guide/>`__ * `Administrator Guide <http://docs.openstack.org/admin-guide/>`__
* `Configuration Reference <http://docs.openstack.org/mitaka/config-reference/>`__ * `Configuration Reference <http://docs.openstack.org/newton/config-reference/>`__
* `Operations Guide <http://docs.openstack.org/ops/>`__ * `Operations Guide <http://docs.openstack.org/ops/>`__
* `Networking Guide <http://docs.openstack.org/mitaka/networking-guide>`__ * `Networking Guide <http://docs.openstack.org/newton/networking-guide>`__
* `High Availability Guide <http://docs.openstack.org/ha-guide/>`__ * `High Availability Guide <http://docs.openstack.org/ha-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 The following books explain how to use the OpenStack dashboard and
command-line clients: command-line clients:
* `API Guide <http://developer.openstack.org/api-guide/quick-start/>`__
* `End User Guide <http://docs.openstack.org/user-guide/>`__ * `End User Guide <http://docs.openstack.org/user-guide/>`__
* `Command-Line Interface Reference * `Command-Line Interface Reference
@ -72,8 +76,7 @@ command-line clients:
The following documentation provides reference and guidance information The following documentation provides reference and guidance information
for the OpenStack APIs: for the OpenStack APIs:
* `API Complete Reference * `API Guide <http://developer.openstack.org/api-guide/quick-start/>`__
(HTML) <http://developer.openstack.org/api-guide/quick-start/>`__
The following guide provides how to contribute to OpenStack documentation: The following guide provides how to contribute to OpenStack documentation:

2
doc/common/cli-manage-images.rst
View File

@ -206,7 +206,7 @@ model:
:command:`glance image-create`. :command:`glance image-create`.
Also, we recommend that you set the ``hypervisor_type="vmware"`` property. Also, we recommend that you set the ``hypervisor_type="vmware"`` property.
For more information, see `Images with VMware vSphere For more information, see `Images with VMware vSphere
<http://docs.openstack.org/mitaka/config-reference/compute/hypervisor-vmware.html#images-with-vmware-vsphere>`_ <http://docs.openstack.org/newton/config-reference/compute/hypervisor-vmware.html#images-with-vmware-vsphere>`_
in the OpenStack Configuration Reference. in the OpenStack Configuration Reference.
.. code-block:: console .. code-block:: console

2
doc/common/get-started-compute.rst
View File

@ -54,7 +54,7 @@ OpenStack Compute consists of the following areas and their components:
by the ``nova-compute`` service. The ``nova-conductor`` module scales by the ``nova-compute`` service. The ``nova-conductor`` module scales
horizontally. However, do not deploy it on nodes where the horizontally. However, do not deploy it on nodes where the
``nova-compute`` service runs. For more information, see `Configuration ``nova-compute`` service runs. For more information, see `Configuration
Reference Guide <http://docs.openstack.org/mitaka/config-reference/compute/conductor.html>`__. Reference Guide <http://docs.openstack.org/newton/config-reference/compute/conductor.html>`__.
``nova-cert`` module ``nova-cert`` module
A server daemon that serves the Nova Cert service for X509 A server daemon that serves the Nova Cert service for X509

2
doc/common/get-started-shared-file-systems.rst
View File

@ -35,4 +35,4 @@ manila-share
Messaging queue Messaging queue
Routes information between the Shared File Systems processes. Routes information between the Shared File Systems processes.
For more information, see `Configuration Reference Guide <http://docs.openstack.org/mitaka/config-reference/content/section_shared-file-systems-overview.html>`__. For more information, see `OpenStack Configuration Reference <http://docs.openstack.org/newton/config-reference/shared-file-systems/overview.html>`__.

22
doc/common/get-started-with-openstack.rst
View File

@ -31,23 +31,23 @@ OpenStack architecture:
* - Service * - Service
- Project name - Project name
- Description - Description
* - `Dashboard <http://www.openstack.org/software/releases/mitaka/components/horizon>`__ * - `Dashboard <http://www.openstack.org/software/releases/newton/components/horizon>`__
- `Horizon <http://docs.openstack.org/developer/horizon/>`__ - `Horizon <http://docs.openstack.org/developer/horizon/>`__
- Provides a web-based self-service portal to interact with underlying - Provides a web-based self-service portal to interact with underlying
OpenStack services, such as launching an instance, assigning IP OpenStack services, such as launching an instance, assigning IP
addresses and configuring access controls. addresses and configuring access controls.
* - `Compute <http://www.openstack.org/software/releases/mitaka/components/nova>`__ * - `Compute <http://www.openstack.org/software/releases/newton/components/nova>`__
- `Nova <http://docs.openstack.org/developer/nova/>`__ - `Nova <http://docs.openstack.org/developer/nova/>`__
- Manages the lifecycle of compute instances in an OpenStack environment. - Manages the lifecycle of compute instances in an OpenStack environment.
Responsibilities include spawning, scheduling and decommissioning of Responsibilities include spawning, scheduling and decommissioning of
virtual machines on demand. virtual machines on demand.
* - `Networking <http://www.openstack.org/software/releases/mitaka/components/neutron>`__ * - `Networking <http://www.openstack.org/software/releases/newton/components/neutron>`__
- `Neutron <http://docs.openstack.org/developer/neutron/>`__ - `Neutron <http://docs.openstack.org/developer/neutron/>`__
- Enables Network-Connectivity-as-a-Service for other OpenStack services, - Enables Network-Connectivity-as-a-Service for other OpenStack services,
such as OpenStack Compute. Provides an API for users to define networks such as OpenStack Compute. Provides an API for users to define networks
and the attachments into them. Has a pluggable architecture that and the attachments into them. Has a pluggable architecture that
supports many popular networking vendors and technologies. supports many popular networking vendors and technologies.
* - `Object Storage <http://www.openstack.org/software/releases/mitaka/components/swift>`__ * - `Object Storage <http://www.openstack.org/software/releases/newton/components/swift>`__
- `Swift <http://docs.openstack.org/developer/swift/>`__ - `Swift <http://docs.openstack.org/developer/swift/>`__
- Stores and retrieves arbitrary unstructured data objects via a RESTful, - Stores and retrieves arbitrary unstructured data objects via a RESTful,
HTTP based API. It is highly fault tolerant with its data replication 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 with mountable directories. In this case, it writes objects and files to
multiple drives, ensuring the data is replicated across a server multiple drives, ensuring the data is replicated across a server
cluster. cluster.
* - `Block Storage <http://www.openstack.org/software/releases/mitaka/components/cinder>`__ * - `Block Storage <http://www.openstack.org/software/releases/newton/components/cinder>`__
- `Cinder <http://docs.openstack.org/developer/cinder/>`__ - `Cinder <http://docs.openstack.org/developer/cinder/>`__
- Provides persistent block storage to running instances. Its pluggable - Provides persistent block storage to running instances. Its pluggable
driver architecture facilitates the creation and management of block driver architecture facilitates the creation and management of block
storage devices. storage devices.
* - `Identity service <http://www.openstack.org/software/releases/mitaka/components/keystone>`__ * - `Identity service <http://www.openstack.org/software/releases/newton/components/keystone>`__
- `Keystone <http://docs.openstack.org/developer/keystone/>`__ - `Keystone <http://docs.openstack.org/developer/keystone/>`__
- Provides an authentication and authorization service for other - Provides an authentication and authorization service for other
OpenStack services. Provides a catalog of endpoints for all OpenStack services. Provides a catalog of endpoints for all
OpenStack services. OpenStack services.
* - `Image service <http://www.openstack.org/software/releases/mitaka/components/glance>`__ * - `Image service <http://www.openstack.org/software/releases/newton/components/glance>`__
- `Glance <http://docs.openstack.org/developer/glance/>`__ - `Glance <http://docs.openstack.org/developer/glance/>`__
- Stores and retrieves virtual machine disk images. OpenStack Compute - Stores and retrieves virtual machine disk images. OpenStack Compute
makes use of this during instance provisioning. makes use of this during instance provisioning.
* - `Telemetry <http://www.openstack.org/software/releases/mitaka/components/ceilometer>`__ * - `Telemetry <http://www.openstack.org/software/releases/newton/components/ceilometer>`__
- `Ceilometer <http://docs.openstack.org/developer/ceilometer/>`__ - `Ceilometer <http://docs.openstack.org/developer/ceilometer/>`__
- Monitors and meters the OpenStack cloud for billing, benchmarking, - Monitors and meters the OpenStack cloud for billing, benchmarking,
scalability, and statistical purposes. scalability, and statistical purposes.
* - `Orchestration <http://www.openstack.org/software/releases/mitaka/components/heat>`__ * - `Orchestration <http://www.openstack.org/software/releases/newton/components/heat>`__
- `Heat <http://docs.openstack.org/developer/heat/>`__ - `Heat <http://docs.openstack.org/developer/heat/>`__
- Orchestrates multiple composite cloud applications by using either the - Orchestrates multiple composite cloud applications by using either the
native HOT template format or the AWS CloudFormation template format, native HOT template format or the AWS CloudFormation template format,
through both an OpenStack-native REST API and a through both an OpenStack-native REST API and a
CloudFormation-compatible Query API. CloudFormation-compatible Query API.
* - `Database service <http://www.openstack.org/software/releases/mitaka/components/trove>`__ * - `Database service <http://www.openstack.org/software/releases/newton/components/trove>`__
- `Trove <http://docs.openstack.org/developer/trove/>`__ - `Trove <http://docs.openstack.org/developer/trove/>`__
- Provides scalable and reliable Cloud Database-as-a-Service functionality - Provides scalable and reliable Cloud Database-as-a-Service functionality
for both relational and non-relational database engines. for both relational and non-relational database engines.
* - `Data processing service <http://www.openstack.org/software/releases/mitaka/components/sahara>`__ * - `Data processing service <http://www.openstack.org/software/releases/newton/components/sahara>`__
- `Sahara <http://docs.openstack.org/developer/sahara/>`__ - `Sahara <http://docs.openstack.org/developer/sahara/>`__
- Provides capabilities to provision and scale Hadoop clusters in OpenStack - Provides capabilities to provision and scale Hadoop clusters in OpenStack
by specifying parameters like Hadoop version, cluster topology and nodes by specifying parameters like Hadoop version, cluster topology and nodes

2
tools/publishdocs.sh
View File

@ -41,8 +41,6 @@ function copy_to_branch {
for f in $(find publish-docs/$BRANCH -name "*.html"); do for f in $(find publish-docs/$BRANCH -name "*.html"); do
sed -i -e "s|/draft/|/$BRANCH/|g" $f sed -i -e "s|/draft/|/$BRANCH/|g" $f
done done
# Debian Install Guide for Newton is not ready
rm -rf publish-docs/$BRANCH/install-guide-debian
fi fi
} }