openstack/openstack-manuals
Code Issues Proposed changes

Update api-ref and api-guide location

Browse Source 
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location in the www directory.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: I4dae852f04b3437179f6769096d47efe8b839c23
This commit is contained in:
Andreas Jaeger 2019-07-22 19:11:18 +02:00
parent df35d11b4c
commit 6f0bb482b4
11 changed files with 28 additions and 28 deletions
tools
www-generator.py
www
.htaccess
mitaka/api
index.html
newton/api
index.html
ocata/api
index.html
pike/api
index.html
queens/api
index.html
redirect-tests.txt
rocky/api
index.html
stein/api
index.html
train/api
index.html

4
tools/www-generator.py

@ -229,13 +229,13 @@ _URLS = [
URLSettings(
flag_name='has_api_ref',
types=['service'],
template='https://developer.openstack.org/api-ref/{service_type}/index.html', # noqa
template='https://docs.openstack.org/api-ref/{service_type}/index.html', # noqa
default=False,
),
URLSettings(
flag_name='has_api_guide',
types=['service'],
template='https://developer.openstack.org/api-guide/{service_type}/index.html', # noqa
template='https://docs.openstack.org/api-guide/{service_type}/index.html', # noqa
default=False,
),
URLSettings(

2
www/.htaccess

@ -77,7 +77,7 @@ redirectmatch 301 ^/language-bindings.html$ /{{ RELEASED_SERIES }}/language-bind
{{ dir_to_page('/run', '/') }}
redirect 301 /developer/index.html /{{ RELEASED_SERIES }}/projects.html
{{ dir_to_page('/cli', '/') }}
redirect 301 /api/api-specs.html http://developer.openstack.org/api-guide/quick-start/index.html
redirect 301 /api/api-specs.html https://docs.openstack.org/api-quick-start/index.html
# Redirect old Admin Guides to new landing page
{{ path_to_released_series('/admin-guide', '/admin/') }}

6
www/mitaka/api/index.html

@ -27,18 +27,18 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>API References</h3>
Combined <a href="https://developer.openstack.org/api-ref.html">API Reference</a><br/>
Combined <a href="https://docs.openstack.org/api-ref.html">API Reference</a><br/>
{% for project in projects|sort(attribute='service') %}
{% if project.has_api_ref or project.has_api_guide or project.has_in_tree_api_docs %}
{{project.service}} ({{project.name}}):
{% if project.has_api_ref %}
<a href="https://developer.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
<a href="https://docs.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
{% endif %}
{% if project.has_in_tree_api_docs %}
<a href="/{{project.name}}/{{SERIES}}/api/"> API Guide</a>
{% endif %}
{% if project.has_api_guide %}
<a href="https://developer.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
<a href="https://docs.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
{% endif %}
<br/>
{% endif %}

6
www/newton/api/index.html

@ -27,18 +27,18 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>API References</h3>
Combined <a href="https://developer.openstack.org/api-ref.html">API Reference</a><br/>
Combined <a href="https://docs.openstack.org/api-ref.html">API Reference</a><br/>
{% for project in projects|sort(attribute='service') %}
{% if project.has_api_ref or project.has_api_guide or project.has_in_tree_api_docs %}
{{project.service}} ({{project.name}}):
{% if project.has_api_ref %}
<a href="https://developer.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
<a href="https://docs.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
{% endif %}
{% if project.has_in_tree_api_docs %}
<a href="/{{project.name}}/{{SERIES}}/api/"> API Guide</a>
{% endif %}
{% if project.has_api_guide %}
<a href="https://developer.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
<a href="https://docs.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
{% endif %}
<br/>
{% endif %}

6
www/ocata/api/index.html

@ -27,18 +27,18 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>API References</h3>
Combined <a href="https://developer.openstack.org/api-ref.html">API Reference</a><br/>
Combined <a href="https://docs.openstack.org/api-ref.html">API Reference</a><br/>
{% for project in projects|sort(attribute='service') %}
{% if project.has_api_ref or project.has_api_guide or project.has_in_tree_api_docs %}
{{project.service}} ({{project.name}}):
{% if project.has_api_ref %}
<a href="https://developer.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
<a href="https://docs.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
{% endif %}
{% if project.has_in_tree_api_docs %}
<a href="/{{project.name}}/{{SERIES}}/api/"> API Guide</a>
{% endif %}
{% if project.has_api_guide %}
<a href="https://developer.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
<a href="https://docs.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
{% endif %}
<br/>
{% endif %}

6
www/pike/api/index.html

@ -27,18 +27,18 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>API References</h3>
Combined <a href="https://developer.openstack.org/api-ref.html">API Reference</a><br/>
Combined <a href="https://docs.openstack.org/api-ref.html">API Reference</a><br/>
{% for project in projects|sort(attribute='service') %}
{% if project.has_api_ref or project.has_api_guide or project.has_in_tree_api_docs %}
{{project.service}} ({{project.name}}):
{% if project.has_api_ref %}
<a href="https://developer.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
<a href="https://docs.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
{% endif %}
{% if project.has_in_tree_api_docs %}
<a href="/{{project.name}}/{{SERIES}}/api/"> API Documentation</a>
{% endif %}
{% if project.has_api_guide %}
<a href="https://developer.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
<a href="https://docs.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
{% endif %}
<br/>
{% endif %}

6
www/queens/api/index.html

@ -27,18 +27,18 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>API References</h3>
Combined <a href="https://developer.openstack.org/api-ref.html">API Reference</a><br/>
Combined <a href="https://docs.openstack.org/api-ref.html">API Reference</a><br/>
{% for project in projects|sort(attribute='service') %}
{% if project.has_api_ref or project.has_api_guide or project.has_in_tree_api_docs %}
{{project.service}} ({{project.name}}):
{% if project.has_api_ref %}
<a href="https://developer.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
<a href="https://docs.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
{% endif %}
{% if project.has_in_tree_api_docs %}
<a href="/{{project.name}}/{{SERIES}}/api/"> API Documentation</a>
{% endif %}
{% if project.has_api_guide %}
<a href="https://developer.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
<a href="https://docs.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
{% endif %}
<br/>
{% endif %}

2
www/redirect-tests.txt

@ -89,7 +89,7 @@
{{ dir_to_page('/run', '/') }}
/developer/index.html 301 /{{ RELEASED_SERIES }}/projects.html
{{ dir_to_page('/cli', '/') }}
/api/api-specs.html 301 http://developer.openstack.org/api-guide/quick-start/index.html
/api/api-specs.html 301 https://docs.openstack.org/api-quick-start/index.html
# Redirect old Admin Guides to new landing page
{{ path_to_released_series('/admin-guide', '/admin/') }}

6
www/rocky/api/index.html

@ -27,18 +27,18 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>API References</h3>
Combined <a href="https://developer.openstack.org/api-ref.html">API Reference</a><br/>
Combined <a href="https://docs.openstack.org/api-ref.html">API Reference</a><br/>
{% for project in projects|sort(attribute='service') %}
{% if project.has_api_ref or project.has_api_guide or project.has_in_tree_api_docs %}
{{project.service}} ({{project.name}}):
{% if project.has_api_ref %}
<a href="https://developer.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
<a href="https://docs.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
{% endif %}
{% if project.has_in_tree_api_docs %}
<a href="/{{project.name}}/{{SERIES}}/api/"> API Documentation</a>
{% endif %}
{% if project.has_api_guide %}
<a href="https://developer.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
<a href="https://docs.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
{% endif %}
<br/>
{% endif %}

6
www/stein/api/index.html

@ -27,18 +27,18 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>API References</h3>
Combined <a href="https://developer.openstack.org/api-ref.html">API Reference</a><br/>
Combined <a href="https://docs.openstack.org/api-ref.html">API Reference</a><br/>
{% for project in projects|sort(attribute='service') %}
{% if project.has_api_ref or project.has_api_guide or project.has_in_tree_api_docs %}
{{project.service}} ({{project.name}}):
{% if project.has_api_ref %}
<a href="https://developer.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
<a href="https://docs.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
{% endif %}
{% if project.has_in_tree_api_docs %}
<a href="/{{project.name}}/{{SERIES}}/api/"> API Documentation</a>
{% endif %}
{% if project.has_api_guide %}
<a href="https://developer.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
<a href="https://docs.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
{% endif %}
<br/>
{% endif %}

6
www/train/api/index.html

@ -27,18 +27,18 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-book"></i>API References</h3>
Combined <a href="https://developer.openstack.org/api-ref.html">API Reference</a><br/>
Combined <a href="https://docs.openstack.org/api-ref.html">API Reference</a><br/>
{% for project in projects|sort(attribute='service') %}
{% if project.has_api_ref or project.has_api_guide or project.has_in_tree_api_docs %}
{{project.service}} ({{project.name}}):
{% if project.has_api_ref %}
<a href="https://developer.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
<a href="https://docs.openstack.org/api-ref/{{project.service_type}}/"> API Reference</a>
{% endif %}
{% if project.has_in_tree_api_docs %}
<a href="/{{project.name}}/{{SERIES}}/api/"> API Documentation</a>
{% endif %}
{% if project.has_api_guide %}
<a href="https://developer.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
<a href="https://docs.openstack.org/api-guide/{{project.service_type}}/"> API Guide</a>
{% endif %}
<br/>
{% endif %}