From 3b9a71d52fe38da52cbabe8a3e3cc5c267aab45c Mon Sep 17 00:00:00 2001 From: "Dr. Jens Harbott" Date: Thu, 28 Mar 2024 07:27:30 +0100 Subject: [PATCH] [www] Set 2024.1 as released and setup 2024.2 Update 2024.1 series info in www-generator.py so that 2024.1 is marked as maintained, thus released. Also add default pages for next release, 2024.2 Dalmatian. This patch needs to be merged at release day, April 3rd. Change-Id: I6aec79ea76cb544a064e0585d294476b79a2ac4f --- tools/www-generator.py | 3 +- www/2024.2/admin/index.html | 69 +++++++++++++++++ www/2024.2/api/index.html | 65 ++++++++++++++++ www/2024.2/badge.html | 1 + www/2024.2/configuration/index.html | 60 +++++++++++++++ www/2024.2/deploy/index.html | 45 +++++++++++ www/2024.2/index.html | 112 ++++++++++++++++++++++++++++ www/2024.2/install/index.html | 75 +++++++++++++++++++ www/2024.2/language-bindings.html | 68 +++++++++++++++++ www/2024.2/projects.html | 1 + www/2024.2/user/index.html | 71 ++++++++++++++++++ 11 files changed, 569 insertions(+), 1 deletion(-) create mode 100644 www/2024.2/admin/index.html create mode 100644 www/2024.2/api/index.html create mode 100644 www/2024.2/badge.html create mode 100644 www/2024.2/configuration/index.html create mode 100644 www/2024.2/deploy/index.html create mode 100644 www/2024.2/index.html create mode 100644 www/2024.2/install/index.html create mode 100644 www/2024.2/language-bindings.html create mode 100644 www/2024.2/projects.html create mode 100644 www/2024.2/user/index.html diff --git a/tools/www-generator.py b/tools/www-generator.py index 1e6b4d1e6b..ab085fc5ae 100755 --- a/tools/www-generator.py +++ b/tools/www-generator.py @@ -75,7 +75,8 @@ SERIES_INFO = collections.OrderedDict([ ('zed', SeriesInfo(date='October 2022', status='maintained')), ('2023.1', SeriesInfo(date='March 2023', status='maintained')), ('2023.2', SeriesInfo(date='October 2023', status='maintained')), - ('2024.1', SeriesInfo(date='April 2024', status='development')), + ('2024.1', SeriesInfo(date='April 2024', status='maintained')), + ('2024.2', SeriesInfo(date='October 2024', status='development')), ]) # Build a list of the series that are not the current series being diff --git a/www/2024.2/admin/index.html b/www/2024.2/admin/index.html new file mode 100644 index 0000000000..231a8e1bff --- /dev/null +++ b/www/2024.2/admin/index.html @@ -0,0 +1,69 @@ +{% set projects = PROJECT_DATA[SERIES] %} +{% extends "templates/base.tmpl" %} +{% block pagetitle %}{{SERIES_TITLE}} Administrator Guides{% endblock %} +{% block title %} +Documentation > Administrator Guides +{% endblock %} +{% block content %} + +
+
+
+
+

OpenStack {{SERIES_TITLE}} Administrator Guides

+

+ This page contains documentation about administering OpenStack services. +

+
+
+
+
+
+
+
+
+

Administrator Guides for OpenStack Services

+{% for project in projects|sort(attribute='name') -%} +{% if project.type in ['service', 'other'] and project.has_admin_guide %} + + {{project.service}} ({{project.name}}) +
+{% endif %} +{%- endfor %} +
+
+
+
+

Administrator Guides for Common OpenStack Libraries

+{% for project in projects|sort(attribute='name') -%} +{% if project.type == 'library' and project.has_admin_guide %} + {{project.name}}
+

{{project.service}}

+{% endif %} +{%- endfor %} +
+
+
+
+

Administrator Guides for OpenStack Deployment Tools

+{% for project in projects|sort(attribute='name') -%} +{% if project.type == 'deployment' and project.has_admin_guide %} + {{project.name}}
+

{{project.service}}

+{% endif %} +{%- endfor %} +
+
+ +
+
+
+

Documentation treated like code, powered by the community - interested?

+ How To Contribute +
+
+
+
+ +{% endblock content %} diff --git a/www/2024.2/api/index.html b/www/2024.2/api/index.html new file mode 100644 index 0000000000..8fb4eb9669 --- /dev/null +++ b/www/2024.2/api/index.html @@ -0,0 +1,65 @@ +{% set projects = PROJECT_DATA[SERIES] %} +{% extends "templates/base.tmpl" %} +{% block pagetitle %}{{SERIES_TITLE}} API references{% endblock %} +{% block title %}API references{% endblock %} +{% block header %} +{% endblock header %} +{% block content %} + +
+
+
+
+

OpenStack {{SERIES_TITLE}} API Reference Documentation

+

+ This page contains documentation about the OpenStack API and how to use it. +

+
+
+
+
+
+
+
+
+
+
+
+
+

API References

+{% 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 %} + API Reference +{% endif %} +{% if project.has_in_tree_api_docs %} + API Documentation +{% endif %} +{% if project.has_api_guide %} + API Guide +{% endif %} +
+{% endif %} +{% endfor %} +
+
+
+
+

User Guides

+ API Guide
+ OpenStack End User Guides (includes Python SDK)
+ Open source software for application development
+
+
+
+
+
+

Documentation treated like code, powered by the community - interested?

+ How To Contribute +
+
+
+
+ +{% endblock content %} diff --git a/www/2024.2/badge.html b/www/2024.2/badge.html new file mode 100644 index 0000000000..d0ad4745d3 --- /dev/null +++ b/www/2024.2/badge.html @@ -0,0 +1 @@ +{% include 'templates/project_deprecated_badge.tmpl' %} \ No newline at end of file diff --git a/www/2024.2/configuration/index.html b/www/2024.2/configuration/index.html new file mode 100644 index 0000000000..6efac85854 --- /dev/null +++ b/www/2024.2/configuration/index.html @@ -0,0 +1,60 @@ +{% set projects = PROJECT_DATA[SERIES] %} +{% extends "templates/base.tmpl" %} +{% block pagetitle %}{{SERIES_TITLE}} Configuration Guides{% endblock %} +{% block title %} +Documentation > Configuration Guides +{% endblock %} +{% block content %} + +
+
+
+
+

OpenStack {{SERIES_TITLE}} Configuration Guides

+

+ This page contains documentation about configuring OpenStack services. +

+
+
+
+
+
+
+
+
+

Configuration Guides for OpenStack Services

+ + General information about configuring OpenStack (oslo.config) +
+{% for project in projects|sort(attribute='name') -%} +{% if project.type in ['service', 'other'] and project.has_config_ref %} + + {{project.service}} ({{project.name}}) +
+{% endif %} +{%- endfor %} +
+
+
+
+

Common Configuration via Libraries

+{% for project in projects|sort(attribute='name') %} +{% if project.type == 'library' and project.has_config_ref %} + {{project.name}}
+

{{project.service}}

+{% endif %} +{% endfor %} +
+
+
+
+
+

Documentation treated like code, powered by the community - interested?

+ How To Contribute +
+
+
+
+ +{% endblock content %} diff --git a/www/2024.2/deploy/index.html b/www/2024.2/deploy/index.html new file mode 100644 index 0000000000..f1c728b1f0 --- /dev/null +++ b/www/2024.2/deploy/index.html @@ -0,0 +1,45 @@ +{% set projects = PROJECT_DATA[SERIES] %} +{% extends "templates/base.tmpl" %} +{% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} +{% block title %} +Documentation > {{SERIES_TITLE}} Deployment Guides +{% endblock %} +{% block content %} + +
+
+
+
+

OpenStack {{SERIES_TITLE}} Deployment Guides

+

The following deployment guides support different installation + methods for core and optional OpenStack services.

+

This is documentation in progress for the next release.

+
+
+
+
+
+
+
+
+

By deployment method

+{% for project in projects|sort(attribute='name') -%} +{% if project.type == 'deployment' and project.has_deployment_guide %} +

+ {{project.service}} Guide +

+{% endif %} +{%- endfor %} +
+
+
+
+
+

Documentation treated like code, powered by the community - interested?

+ How To Contribute +
+
+
+
+ +{% endblock content %} diff --git a/www/2024.2/index.html b/www/2024.2/index.html new file mode 100644 index 0000000000..994edc3a0c --- /dev/null +++ b/www/2024.2/index.html @@ -0,0 +1,112 @@ +{% extends "templates/indexbase.tmpl" %} +{% block pagetitle %}{{SERIES_TITLE}}{% endblock %} +{% block title %}{% endblock %} +{% block header %} +{% endblock header %} +{% block content %} +
+
+
+
+
+
+
+

Release Notes

+

New features, upgrade and deprecation notes, known issues, and bug fixes

+ OpenStack Projects Release Notes + OpenStack Documentation Release Notes +
+
+

Installation Guides

+

Getting started with the most commonly used OpenStack services

+ Installation Guides +
+
+

Deployment Guides

+

Choose how to deploy OpenStack and get started with the most commonly used OpenStack services

+ Deployment Guides +
+
+

Operations and Administration Guides

+ Administrator Guides +

Manage and troubleshoot an OpenStack cloud

+ +

Install and configure OpenStack for high availability

+ Architecture Guide +

Plan and design an OpenStack cloud

+ Operations Guide +

Operate an OpenStack cloud

+ Security Guide +

Guidelines and scenarios for creating more secure OpenStack clouds

+ Virtual Machine Image Guide[PDF] +

Obtain, create, and modify OpenStack-compatible virtual machine images

+
+
+

Configuration Guides

+ Configuration Reference +

Installation and configuration options for OpenStack

+
+
+

API Guides

+ API Guides +

OpenStack API Documentation

+
+
+
+
+

User Guides

+ End User Guides +

Create and manage resources using the OpenStack dashboard, command-line client, and Python SDK

+ Open source software for application development +

Resources for application development on OpenStack clouds

+
+
+

Project-specific Guides

+ Services and Libraries +

Documentation for OpenStack services and libraries

+ Language Bindings and Python Clients +

Documentation for the OpenStack Python bindings and clients

+
+
+

SIG-specific Documentation

+ Extended Maintenance SIG +

The Extended Maintenance SIG manages the existing stable branches

+ Self-healing SIG documentation +

Self-healing use cases and implementation details

+ Large Scale SIG documentation +

The journey of running OpenStack at large scale

+
+
+

Contributor Guides

+ The OpenStack Contributor Guide +

The contribution process explained

+ OpenStack Documentation Contributor Guide +

Documentation workflow and conventions

+ OpenStack Technical Committee Governance Documents +

OpenStack Technical Committee reference documents and official resolutions

+ OpenStack Project specifications +

Specifications for future project features

+ OpenStack Project Team Guide +

Guide to the OpenStack project and community

+ OpenStack Testing and Collaboration Tools Documentation +

Community-managed development and communication systems

+ OpenStack I18n Guide +

Internationalization workflow and conventions

+ Join the Open Infrastructure Foundation +

How to join the Open Infrastructure Foundation

+ Take the Deployment Survey +

Influence the future of OpenStack

+
+
+

Training Guides and Training Labs

+ Upstream training +

Resources for the OpenStack Upstream Training program

+ Training Labs +

Tools for OpenStack Training. Automatic deployment of lean virtualized multi-node openstack cluster.

+
+
+
+
+ +{% endblock content %} diff --git a/www/2024.2/install/index.html b/www/2024.2/install/index.html new file mode 100644 index 0000000000..b9b0044fd2 --- /dev/null +++ b/www/2024.2/install/index.html @@ -0,0 +1,75 @@ +{% set projects = PROJECT_DATA[SERIES] %} +{% extends "templates/base.tmpl" %} +{% block pagetitle %}{{SERIES_TITLE}} Installation Guides{% endblock %} +{% block title %} +Documentation > {{SERIES_TITLE}} Installation Guides +{% endblock %} +{% block content %} + +
+
+
+
+

OpenStack {{SERIES_TITLE}} Installation Guides

+

+ These documents cover installation procedures for OpenStack + services. +

+

+ If you prefer to install OpenStack using an automated deployment + tool, see the Deployment Guides. +

+
+
+
+
+
+
+
+
+
+

Installation Guide

+

The following guide provides information about getting started, + setting up your environment, and launching your instance. +

+

+ + OpenStack Installation Guide + +

+
+
+
+
+

Project Installation Guides

+ +
+
+
+
+

Documentation treated like code, powered by the community - interested?

+ How To Contribute +
+
+
+
+ + +{% endblock content %} diff --git a/www/2024.2/language-bindings.html b/www/2024.2/language-bindings.html new file mode 100644 index 0000000000..bf04cd0626 --- /dev/null +++ b/www/2024.2/language-bindings.html @@ -0,0 +1,68 @@ +{% set projects = PROJECT_DATA[SERIES] %} +{% extends "templates/base.tmpl" %} +{% block pagetitle %}{{SERIES_TITLE}} Language bindings{% endblock %} +{% block title %} +Documentation > Language Bindings and Python Clients +{% endblock %} +{% block content %} + +
+
+
+
+

OpenStack {{SERIES_TITLE}} API Bindings

+

+ This page contains documentation about the Python + bindings provided by OpenStack and how to use them. +

+
+
+
+
+
+
+
+
+

Bindings for the OpenStack APIs

+{% for project in projects|sort(attribute='service') -%} +{% if project.type == 'cloud-client' and project.name != 'python-openstackclient' %} + + {{project.service}} ({{project.description}}) +
+{% endif %} +{%- endfor %} +
+
+

Bindings for individual OpenStack service APIs

+{% for project in projects|sort(attribute='service') -%} +{% if project.type == 'service-client' %} + + {{project.service}} ({{project.description}}) +
+{% endif %} +{%- endfor %} +
+
+
+
+

Use the unified command-line client

+ + Unified OpenStack Client +
+

+ Documentation for python-openstackclient, a unified shell command structure. +

+
+
+
+
+
+

Documentation treated like code, powered by the community - interested?

+ How To Contribute +
+
+
+
+ +{% endblock content %} diff --git a/www/2024.2/projects.html b/www/2024.2/projects.html new file mode 100644 index 0000000000..badd874e92 --- /dev/null +++ b/www/2024.2/projects.html @@ -0,0 +1 @@ +{% extends "templates/project_list.tmpl" %} diff --git a/www/2024.2/user/index.html b/www/2024.2/user/index.html new file mode 100644 index 0000000000..173ec21ea1 --- /dev/null +++ b/www/2024.2/user/index.html @@ -0,0 +1,71 @@ +{% set projects = PROJECT_DATA[SERIES] %} +{% extends "templates/base.tmpl" %} +{% block pagetitle %}{{SERIES_TITLE}} User Guides{% endblock %} +{% block title %} +Documentation > User Guides +{% endblock %} +{% block content %} + +
+
+
+
+

OpenStack {{SERIES_TITLE}} Project User Guides

+

+ This page contains project-specific documentation for + using OpenStack services and libraries. +

+
+
+
+
+
+
+
+
+
+
+
+
+

User Guides for OpenStack Services

+{% for project in projects|sort(attribute='service') %} +{% if project.type in ['service', 'other'] and project.has_user_guide %} + + {{project.service}} ({{project.name}})
+{% endif %} +{% endfor %} +
+
+ +
+
+

User Guides for OpenStack Deployment Tools

+{% for project in projects|sort(attribute='service') %} +{% if project.type in ['deployment'] and project.has_user_guide %} + + {{project.service}} ({{project.name}})
+{% endif %} +{% endfor %} +
+
+ +
+
+

Client Libraries

+

Refer to the + language bindings list for Python client library + documentation and the Unified OpenStack command line + client.

+
+
+ +
+
+

Documentation treated like code, powered by the community - interested?

+ How To Contribute +
+
+
+
+ +{% endblock content %}