diff --git a/doc/common/app-support.rst b/doc/common/app-support.rst index 02534e62be..deab3e816e 100644 --- a/doc/common/app-support.rst +++ b/doc/common/app-support.rst @@ -19,63 +19,63 @@ Documentation ~~~~~~~~~~~~~ For the available OpenStack documentation, see -`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 `__, +List `_, join our IRC channel ``#openstack-doc`` on the freenode IRC network, or `report a -bug `__. +bug `_. The following books explain how to install an OpenStack cloud and its associated components: * `Installation Tutorial for openSUSE Leap 42.2 and SUSE Linux Enterprise Server 12 SP2 - `__ + `_ * `Installation Tutorial for Red Hat Enterprise Linux 7 and CentOS 7 - `__ + `_ * `Installation Tutorial for Ubuntu 16.04 (LTS) - `__ + `_ The following books explain how to configure and run an OpenStack cloud: -* `Architecture Design Guide `__ +* `Architecture Design Guide `_ -* `Administrator Guide `__ +* `Administrator Guide `_ -* `Configuration Reference `__ +* `Configuration Reference `_ -* `Operations Guide `__ +* `Operations Guide `_ -* `Networking Guide `__ +* `Networking Guide `_ -* `High Availability Guide `__ +* `High Availability Guide `_ -* `Security Guide `__ +* `Security Guide `_ -* `Virtual Machine Image Guide `__ +* `Virtual Machine Image Guide `_ The following books explain how to use the OpenStack Dashboard and command-line clients: -* `End User Guide `__ +* `End User Guide `_ * `Command-Line Interface Reference - `__ + `_ The following documentation provides reference and guidance information for the OpenStack APIs: -* `API Guide `__ +* `API Guide `_ The following guide provides how to contribute to OpenStack documentation: -* `Documentation Contributor Guide `__ +* `Documentation Contributor Guide `_ ask.openstack.org ~~~~~~~~~~~~~~~~~ @@ -83,7 +83,7 @@ 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 +`ask.openstack.org `_ site to ask questions and get answers. When you visit the `Ask OpenStack `_ site, scan the recently asked questions to see whether your question has already @@ -101,12 +101,12 @@ and help others who might have similar issues. To subscribe or view the archives, go to the `general OpenStack mailing list `_. If you are interested in the other mailing lists for specific projects or development, -refer to `Mailing Lists `__. +refer to `Mailing Lists `_. The OpenStack wiki ~~~~~~~~~~~~~~~~~~ -The `OpenStack wiki `__ contains a broad +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 feature enables you to search by title or content. If you search for specific information, such @@ -120,7 +120,7 @@ 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 -https://launchpad.net/+login. You can view existing bugs and report bugs +``_. You can view existing bugs and report bugs in the Launchpad Bugs area. Use the search feature to determine whether the bug has already been reported or already been fixed. If it still seems like your bug is unreported, fill out a bug report. @@ -143,69 +143,69 @@ Some tips: The following Launchpad Bugs areas are available: * `Bugs: OpenStack Block Storage - (cinder) `__ + (cinder) `_ -* `Bugs: OpenStack Compute (nova) `__ +* `Bugs: OpenStack Compute (nova) `_ * `Bugs: OpenStack Dashboard - (horizon) `__ + (horizon) `_ * `Bugs: OpenStack Identity - (keystone) `__ + (keystone) `_ * `Bugs: OpenStack Image service - (glance) `__ + (glance) `_ * `Bugs: OpenStack Networking - (neutron) `__ + (neutron) `_ * `Bugs: OpenStack Object Storage - (swift) `__ + (swift) `_ -* `Bugs: Application catalog (murano) `__ +* `Bugs: Application catalog (murano) `_ -* `Bugs: Bare metal service (ironic) `__ +* `Bugs: Bare metal service (ironic) `_ -* `Bugs: Clustering service (senlin) `__ +* `Bugs: Clustering service (senlin) `_ -* `Bugs: Container Infrastructure Management service (magnum) `__ +* `Bugs: Container Infrastructure Management service (magnum) `_ * `Bugs: Data processing service - (sahara) `__ + (sahara) `_ -* `Bugs: Database service (trove) `__ +* `Bugs: Database service (trove) `_ -* `Bugs: Deployment service (fuel) `__ +* `Bugs: Deployment service (fuel) `_ -* `Bugs: DNS service (designate) `__ +* `Bugs: DNS service (designate) `_ -* `Bugs: Key Manager Service (barbican) `__ +* `Bugs: Key Manager Service (barbican) `_ -* `Bugs: Monitoring (monasca) `__ +* `Bugs: Monitoring (monasca) `_ -* `Bugs: Orchestration (heat) `__ +* `Bugs: Orchestration (heat) `_ -* `Bugs: Rating (cloudkitty) `__ +* `Bugs: Rating (cloudkitty) `_ -* `Bugs: Shared file systems (manila) `__ +* `Bugs: Shared file systems (manila) `_ * `Bugs: Telemetry - (ceilometer) `__ + (ceilometer) `_ * `Bugs: Telemetry v3 - (gnocchi) `__ + (gnocchi) `_ * `Bugs: Workflow service - (mistral) `__ + (mistral) `_ * `Bugs: Messaging service - (zaqar) `__ + (zaqar) `_ * `Bugs: OpenStack API Documentation - (developer.openstack.org) `__ + (developer.openstack.org) `_ * `Bugs: OpenStack Documentation - (docs.openstack.org) `__ + (docs.openstack.org) `_ The OpenStack IRC channel ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -214,7 +214,7 @@ The OpenStack community lives in the #openstack IRC channel on the Freenode network. You can hang out, ask questions, or get immediate feedback for urgent and pressing issues. To install an IRC client or use a browser-based client, go to -`https://webchat.freenode.net/ `__. You can +`https://webchat.freenode.net/ `_. You can also use `Colloquy `_ (Mac OS X), `mIRC `_ (Windows), or XChat (Linux). When you are in the IRC channel @@ -232,9 +232,9 @@ Documentation feedback To provide feedback on documentation, join and use the openstack-docs@lists.openstack.org mailing list at `OpenStack Documentation Mailing -List `__, +List `_, or `report a -bug `__. +bug `_. OpenStack distribution packages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/install-guide/source/environment.rst b/doc/install-guide/source/environment.rst index 06a5b16e56..74c287f49b 100644 --- a/doc/install-guide/source/environment.rst +++ b/doc/install-guide/source/environment.rst @@ -71,7 +71,7 @@ of nested VMs. interface. For more information about system requirements, see the `OpenStack -Operations Guide `_. +Operations Guide `_. .. toctree:: :maxdepth: 1 diff --git a/doc/install-guide/source/overview.rst b/doc/install-guide/source/overview.rst index 8483cd8c78..981f0f5a5a 100644 --- a/doc/install-guide/source/overview.rst +++ b/doc/install-guide/source/overview.rst @@ -48,9 +48,9 @@ follows: network instead of a dedicated network. For more information on production architectures, see the -`Architecture Design Guide `__, -`OpenStack Operations Guide `__, and -`OpenStack Networking Guide `__. +`Architecture Design Guide `_, +`OpenStack Operations Guide `_, and +`OpenStack Networking Guide `_. .. _figure-hwreqs: diff --git a/www/arch/index.html b/www/arch/index.html deleted file mode 100644 index 5359b0bc4a..0000000000 --- a/www/arch/index.html +++ /dev/null @@ -1,98 +0,0 @@ -{% set scriptdir = '../common/js/' %} -{% set cssdir = '../common/css/' %} -{% extends "templates/base.tmpl" %} -{% block pagetitle %}Architecture Design Guide{% endblock %} -{% block title %} -Documentation > Architecture Design Guide -{% endblock %} -{% block content %} -
-
-
-
-

OpenStack Architecture Design Guide

-

The OpenStack Architecture Design Guide offers examples of OpenStack deployments for different use cases. -Authors who know how to design clouds that meet users' needs wrote this book in a five-day book sprint.

-
-

Get the Book!

- - Current HTML - buy it from Lulu - -
-
- -
- -
-
-
- - -
-
-
-
-
-
- -
-

- Read this book to learn about these types of use cases for OpenStack clouds: -

-
    -
  • - General purpose: compute, network, and storage components balanced for scale-out, general purpose applications. -
    • -
  • - Compute focused: built and designed specifically to support compute intensive workloads such as high performance computing, big data analysis, continuous integration or continuous deployment, and Platform-as-a-Service. -
    • -
  • - Storage focused: data management through cloud storage solutions to support applications like archiving, data analytics, content storage and synchronization, media streaming, databases, and content distribution. -
    • -
  • - Network focused: when users require network services beyond the usual cloud use cases, such as content delivery networks, network services like VPN or GRE tunnels, and web portals or web services. -
    • -
  • - Multi-site clouds: when services are hosted in more than one data center to spread out the geographic footprint for redundancy or for location-sensitive data -
    • -
  • - Hybrid clouds: when the design spans more than one cloud, you plan for a hybrid cloud architecture. -
    • -
  • - Massively scalable: for large deployments serving many users with many resources available, often for public clouds -
    • -
  • - Specialized cases: describes multi-hypervisor examples, specialized networking, desktop-as-a-service, OpenStack on OpenStack, and the use of specialized hardware in a cloud's design. -
    • -
-

- If you'd like a bound copy, - - buy it from Lulu - - and all proceeds go to the Foundation to support more book sprints efforts like this one. -

-

- Support independent publishing: Buy this book on Lulu. -

-
- -
- -

- - Creative Commons License - -
- This work is licensed under a - - Creative Commons Attribution 3.0 United States License - - . -

-
-
-
- -{% endblock content %} diff --git a/www/ops/index.html b/www/ops/index.html deleted file mode 100644 index 7dbd8cc73b..0000000000 --- a/www/ops/index.html +++ /dev/null @@ -1,55 +0,0 @@ -{% set scriptdir = '../common/js/' %} -{% set cssdir = '../common/css/' %} -{% extends "templates/base.tmpl" %} -{% block pagetitle %}Operations Guide{% endblock %} -{% block title %} -Documentation > Operations Guide -{% endblock %} -{% block content %} -
-
-
-
-

OpenStack Operations Guide

-

- This book offers hard-earned experience from OpenStack operators who have run OpenStack - in production for six months or longer. They've gathered their notes, shared their stories, - and learned from each other. We invite you to join in the quest for best practices - in OpenStack cloud operations. You can read the - - latest updates - . -

-
-

Get the Book!

- Current HTML - -
-
-
-
-
-
-
-
-
-
-

- -

-

- - Creative Commons License - -
- This work is licensed under a - - Creative Commons Attribution 3.0 United States License - - . -

-
-
-
-{% endblock content %} diff --git a/www/static/.htaccess b/www/static/.htaccess index 4f6fbb33b0..1258259666 100644 --- a/www/static/.htaccess +++ b/www/static/.htaccess @@ -83,8 +83,12 @@ redirectmatch /network-admin/admin/content/.*$ /admin-guide/index.html # Redirect O'Reilly Operations Guide PDF to trunk version redirect 301 /trunk/openstack-ops/oreilly-openstack-ops-guide.pdf /openstack-ops/openstack-ops-manual.pdf -# Redirect Operations Guide to /openstack-ops +# Redirect Operations Guide to /openstack-ops-guide redirectmatch 301 /trunk/openstack-ops/.*$ /ops-guide/ +redirect 301 /ops/index.html /ops-guide/index.html + +# Redirect Architecture Guide to /openstack-arch-design +redirect 301 /arch/index.html /arch-design/index.html # A doc generation bug resulted in Google indexing links containing "//", which cause # problems with linked content (images/css/etc). This rule generates a 301 redirect diff --git a/www/templates/ops_and_admin_guides.tmpl b/www/templates/ops_and_admin_guides.tmpl index 0aed3fd1da..60a49f1090 100644 --- a/www/templates/ops_and_admin_guides.tmpl +++ b/www/templates/ops_and_admin_guides.tmpl @@ -3,7 +3,7 @@

Manage and troubleshoot an OpenStack cloud

High Availability Guide

Install and configure OpenStack for high availability

- Operations Guide + Operations Guide

Design, create, and administer a production OpenStack cloud

Security Guide

Guidelines and scenarios for creating more secure OpenStack clouds