add api landing pages for older releases

Add reduced project-data files for older releases that only include
projects with API reference docs or guides to allow us to copy the API
landing page template from pike.

Change-Id: I143f7986f7c6d730696715b687d4e010a23b5a45
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-07-24 11:37:11 -04:00
parent f765a67ea1
commit fa85f4e462
8 changed files with 577 additions and 2 deletions

65
www/mitaka/api/index.html Normal file
View File

@ -0,0 +1,65 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}API references{% endblock %}
{% block title %}API references{% endblock %}
{% block header %}
{% endblock header %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} API Reference Documentation</h1>
<p>
This page contains documentation about the OpenStack API and how to use it.
</p>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row">
<div class="col-lg-12">
</div>
</div>
<div class="row docs-toc">
<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/>
{% 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>
{% 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>
{% endif %}
<br/>
{% endif %}
{% endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cloud"></i> User Guides</h3>
<a href="https://developer.openstack.org/api-guide/quick-start/">API Guide</a><br/>
<a href="https://developer.openstack.org">Open source software for application development</a><br/>
</div>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/contributor-guide/" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
<!-- End Page Content -->
{% endblock content %}

65
www/newton/api/index.html Normal file
View File

@ -0,0 +1,65 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}API references{% endblock %}
{% block title %}API references{% endblock %}
{% block header %}
{% endblock header %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} API Reference Documentation</h1>
<p>
This page contains documentation about the OpenStack API and how to use it.
</p>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row">
<div class="col-lg-12">
</div>
</div>
<div class="row docs-toc">
<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/>
{% 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>
{% 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>
{% endif %}
<br/>
{% endif %}
{% endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cloud"></i> User Guides</h3>
<a href="https://developer.openstack.org/api-guide/quick-start/">API Guide</a><br/>
<a href="https://developer.openstack.org">Open source software for application development</a><br/>
</div>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/contributor-guide/" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
<!-- End Page Content -->
{% endblock content %}

65
www/ocata/api/index.html Normal file
View File

@ -0,0 +1,65 @@
{% set projects = PROJECT_DATA[SERIES] %}
{% extends "templates/base.tmpl" %}
{% block pagetitle %}API references{% endblock %}
{% block title %}API references{% endblock %}
{% block header %}
{% endblock header %}
{% block content %}
<!-- Begin Page Content -->
<div class="top-docs-wrapper">
<div class="container">
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8">
<h1>OpenStack {% if SERIES != 'latest' %}{{SERIES|title}}{% endif %} API Reference Documentation</h1>
<p>
This page contains documentation about the OpenStack API and how to use it.
</p>
</div>
</div>
</div>
<div class="mid-docs-wrapper" id="docs-main-body">
<div class="container">
<div class="row">
<div class="col-lg-12">
</div>
</div>
<div class="row docs-toc">
<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/>
{% 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>
{% 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>
{% endif %}
<br/>
{% endif %}
{% endfor %}
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cloud"></i> User Guides</h3>
<a href="https://developer.openstack.org/api-guide/quick-start/">API Guide</a><br/>
<a href="https://developer.openstack.org">Open source software for application development</a><br/>
</div>
</div>
</div>
<div class="row docs-contribute-wrapper">
<div class="col-lg-12">
<p>Documentation treated like code, powered by the community - interested?</p>
<a href="/contributor-guide/" class="overview-btn contribute-btn">How To Contribute <i class="fa fa-chevron-right"></i></a>
</div>
</div>
</div>
</div>
<!-- End Page Content -->
{% endblock content %}

View File

@ -81,7 +81,7 @@
</div>
<div class="docs-link-sections">
<h3 id="api-guides"><i class="fa fa-book"></i> API Guides</h3>
<a href="/api/">API Guides</a>
<a href="api">API Guides</a>
<p>OpenStack API Documentation</p>
</div>
</div>

View File

@ -0,0 +1,127 @@
---
# Schema: See schema.yaml and README.txt
- name: keystone
service: Identity service
service_type: identity
has_api_ref: true
type: service
- name: glance
service: Image service
service_type: image
has_api_ref: true
type: service
- name: nova
service: Compute service
service_type: compute
has_api_ref: true
has_api_guide: true
type: service
- name: neutron
service: Networking service
service_type: network
has_api_ref: true
type: service
- name: cinder
service: Block Storage service
service_type: block-storage
type: service
has_api_ref: true
- name: ironic
service: Bare Metal service
service_type: baremetal
has_api_ref: true
type: service
- name: magnum
service: Container Infrastructure Management service
service_type: container-infrastructure-management
has_api_ref: true
type: service
- name: trove
service: Database service
service_type: database
has_api_ref: true
type: service
- name: designate
service: DNS service
service_type: dns
has_api_ref: true
type: service
- name: barbican
service: Key Manager service
service_type: key-manager
has_api_guide: true
has_api_ref: true
type: service
- name: zaqar
service: Messaging service
service_type: message
has_api_ref: true
type: service
- name: swift
service: Object Storage service
service_type: object-store
has_api_ref: true
type: service
- name: heat
service: Orchestration service
service_type: orchestration
has_in_tree_api_docs: true
has_api_ref: true
type: service
- name: manila
service: Shared File Systems service
service_type: shared-file-system
has_api_ref: true
type: service
- name: sahara
service: Data Processing service
service_type: data-processing
has_api_ref: true
type: service
- name: murano
service: Application Catalog service
service_type: application-catalog
type: service
has_api_ref: true
- name: senlin
service: Clustering service
service_type: resource-cluster
type: service
has_api_ref: true
- name: tacker
service: NFV Orchestration service
service_type: nfv-orchestration
type: service
has_api_ref: true
- name: searchlight
service: Search service
# NOTE(dhellmann): This causes /search/ to redirect to the
# searchlight documentation.
service_type: search
type: service
has_api_ref: true
- name: octavia
service: Load-balancer service
service_type: load-balancer
has_api_ref: true
type: service

View File

@ -0,0 +1,120 @@
---
# Schema: See schema.yaml and README.txt
- name: keystone
service: Identity service
service_type: identity
has_api_ref: true
type: service
- name: glance
service: Image service
service_type: image
has_api_ref: true
type: service
- name: nova
service: Compute service
service_type: compute
has_api_ref: true
has_api_guide: true
type: service
- name: neutron
service: Networking service
service_type: network
has_api_ref: true
type: service
- name: cinder
service: Block Storage service
service_type: block-storage
type: service
has_api_ref: true
- name: ironic
service: Bare Metal service
service_type: baremetal
has_api_ref: true
type: service
- name: magnum
service: Container Infrastructure Management service
service_type: container-infrastructure-management
has_api_ref: true
type: service
- name: trove
service: Database service
service_type: database
has_api_ref: true
type: service
- name: designate
service: DNS service
service_type: dns
has_api_ref: true
type: service
- name: barbican
service: Key Manager service
service_type: key-manager
has_api_guide: true
has_api_ref: true
type: service
- name: zaqar
service: Messaging service
service_type: message
has_api_ref: true
type: service
- name: swift
service: Object Storage service
service_type: object-store
has_api_ref: true
type: service
- name: manila
service: Shared File Systems service
service_type: shared-file-system
has_api_ref: true
type: service
- name: sahara
service: Data Processing service
service_type: data-processing
has_api_ref: true
type: service
- name: murano
service: Application Catalog service
service_type: application-catalog
type: service
has_api_ref: true
- name: tacker
service: NFV Orchestration service
service_type: nfv-orchestration
type: service
has_api_ref: true
- name: searchlight
service: Search service
# NOTE(dhellmann): This causes /search/ to redirect to the
# searchlight documentation.
service_type: search
type: service
has_api_ref: true
- name: octavia
service: Load-balancer service
service_type: load-balancer
has_api_ref: true
type: service
- name: karbor
service: Data Protection Orchestration Service
service_type: data-protection-orchestration
has_api_ref: true
type: service

133
www/project-data/ocata.yaml Normal file
View File

@ -0,0 +1,133 @@
---
# Schema: See schema.yaml and README.txt
- name: keystone
service: Identity service
service_type: identity
has_api_ref: true
type: service
- name: glance
service: Image service
service_type: image
has_api_ref: true
type: service
- name: nova
service: Compute service
service_type: compute
has_api_ref: true
has_api_guide: true
type: service
- name: neutron
service: Networking service
service_type: network
has_api_ref: true
type: service
- name: cinder
service: Block Storage service
service_type: block-storage
type: service
has_api_ref: true
- name: ironic
service: Bare Metal service
service_type: baremetal
has_api_ref: true
type: service
- name: magnum
service: Container Infrastructure Management service
service_type: container-infrastructure-management
has_api_ref: true
type: service
- name: trove
service: Database service
service_type: database
has_api_ref: true
type: service
- name: designate
service: DNS service
service_type: dns
has_api_ref: true
type: service
- name: barbican
service: Key Manager service
service_type: key-manager
has_api_guide: true
has_api_ref: true
type: service
- name: zaqar
service: Messaging service
service_type: message
has_api_ref: true
type: service
- name: swift
service: Object Storage service
service_type: object-store
has_api_ref: true
type: service
- name: heat
service: Orchestration service
service_type: orchestration
has_in_tree_api_docs: true
has_api_ref: true
type: service
- name: manila
service: Shared File Systems service
service_type: shared-file-system
has_api_ref: true
type: service
- name: sahara
service: Data Processing service
service_type: data-processing
has_api_ref: true
type: service
- name: murano
service: Application Catalog service
service_type: application-catalog
type: service
has_api_ref: true
- name: senlin
service: Clustering service
service_type: resource-cluster
type: service
has_api_ref: true
- name: tacker
service: NFV Orchestration service
service_type: nfv-orchestration
type: service
has_api_ref: true
- name: searchlight
service: Search service
# NOTE(dhellmann): This causes /search/ to redirect to the
# searchlight documentation.
service_type: search
type: service
has_api_ref: true
- name: octavia
service: Load-balancer service
service_type: load-balancer
has_api_ref: true
type: service
- name: karbor
service: Data Protection Orchestration Service
service_type: data-protection-orchestration
has_api_ref: true
type: service

View File

@ -1,5 +1,5 @@
<div class="docs-link-sections">
<h3 id="api-guides"><i class="fa fa-book"></i> API Guides</h3>
<a href="/api/">API Guides</a>
<a href="api/">API Guides</a>
<p>OpenStack API Documentation</p>
</div>