openinfra
/
openstack-map
Code Issues Proposed changes
Base data to generate the OpenStack map and the Software section of the www.openstack.org website.
84 Commits 1 Branch 0 Tags 580 KiB
Go to file
Thierry Carrez b64af256b2 Include info on which components are in bold 
The map diagram[1] (produced manually by the OSF design team based
on information in this repository) includes a number of projects
in bold (representing "core functionality"), in an effort to
make the map more readable and attract the viewer to most
commonly-used components.

In order to be able to propose and discuss that other components
be represented in bold (or to suggest the removal of all bolding
altogether), add the current state to the YAML.

[1] https://openstack.org/openstack-map

Change-Id: I61ce1af96f51e2b5750e2a1b813f10c5831a9e81
 		2020-06-12 11:38:12 +02:00
.gitignore Add YAML linting in check and gate 2019-01-07 11:34:04 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:25:32 +00:00
.zuul.yaml Add YAML linting in check and gate 2019-01-07 11:34:04 +01:00
README.rst Document YAML file schema in README 2018-12-20 15:07:21 +01:00
deployment_tools.yaml Add features for kolla and kayobe 2020-02-05 16:32:33 +00:00
deployment_tools_capabilities.yaml Fix capabilities following initial review 2019-07-03 14:15:21 +02:00
openstack_components.yaml Include info on which components are in bold 2020-06-12 11:38:12 +02:00
sdks.yaml Update the prelude/description 2018-12-27 14:46:51 -06:00
tox.ini Add YAML linting in check and gate 2019-01-07 11:34:04 +01:00

README.rst

Using This Repository

This repository contains information about OpenStack first-order deliverables, to be used to generate the OpenStack map and "software" pages on the openstack.org website.

What should be included

The goal is to provide a user-facing view of OpenStack deliverables. As such, only first-order deliverables (components that users actually opt into installing) are presented. Libraries, pure dependencies and other second-level deliverables should not be included.

File structure

This repository contains one file for the OpenStack components themselves (openstack_components.yaml), one for tools that can be used to deploy them (deployment_tools.yaml) and one for tools that can be used client-side to interact with them (sdks.yaml).

Each file has a super-structure with tabs and categories, under which each component can be added.

Component schema

Each component is defined by a YAML dictionary with the following keys:

name

The component name (mandatory).

title

A user-friendly short description of the component role (mandatory).

docs-title

Text to use for a link to further documentation (optional).

docs-url

URL to use for a link to further documentation (optional).

desc

Long description of the component role (mandatory).

project-team

Name of the project team that produces this deliverable, as found in the openstack/governance repository in the reference/projects.yaml file (mandatory).

support-teams

List of other project teams (such as I18n, Docs...) to credit for helping in the production of that component, as found in the openstack/governance repository in the reference/projects.yaml file (optional).

since

First OpenStack release that included that component (optional).

video

Video to embed. Currently only supports linking to YouTube videos (optional).

id

YouTube ID for the video.

title

Title for the video.

desc

Description of the video.

dependencies

List of other component names that are hard dependencies for this component (can't work without them) (optional, only for openstack_components.yaml).

see-also

List of other component names that are soft dependencies for this component (benefits of the presence of them) (optional, only for openstack_components.yaml).