Documentation Logo

Demo documentation

The demo documentation provides example markup for looking at the expected output.

The project aims for simple implementation, massive scalability, and a rich set of features. Cloud computing experts from around the world contribute to the project.

Glossary

Here’s an example glossary:

Cactus

An OpenStack grouped release of projects that came out in the spring of 2011. It included Compute (nova), Object Storage (swift), and the Image service (glance). Cactus is a city in Texas, US and is the code name for the third release of OpenStack. When OpenStack releases went from three to six months long, the code name of the release changed to match a geography nearest the previous summit.

CADF

Cloud Auditing Data Federation (CADF) is a specification for audit event data. CADF is supported by OpenStack Identity.

CALL

One of the RPC primitives used by the OpenStack message queue software. Sends a message and waits for a response.

Literal Blocks

Here’s an example configuration:

[DEFAULT]
...
my_ip = 10.0.0.31
vnc_enabled = True
vncserver_listen = 0.0.0.0
vncserver_proxyclient_address = 10.0.0.31
novncproxy_base_url = http://controller:6080/vnc_auto.html

Code Blocks

Here’s another example that’s python code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
def builder_inited(app):
    theme_dir = os.path.join(os.path.dirname(__file__), 'theme')
    LOG.info('Using openstack theme from %s' % theme_dir)
    # Insert our theme directory at the front of the search path and
    # force the theme setting to use the one in the package. This is
    # done here, instead of in setup(), because conf.py is read after
    # setup() runs, so if the conf contains these values the user
    # values overwrite these. That's not bad for the theme, but it
    # breaks the search path.
    app.config.html_theme_path.insert(0, theme_dir)
    # Set the theme name
    app.config.html_theme = 'openstack'
    # Re-initialize the builder, if it has the method for setting up
    # the templates and theme.
    if hasattr(app.builder, 'init_templates'):
        app.builder.init_templates()

Here’s the same example but with ..code-block: ini to test the pygments lexer:

[DEFAULT]
...
my_ip = 10.0.0.31
vnc_enabled = True
vncserver_listen = 0.0.0.0
vncserver_proxyclient_address = 10.0.0.31
novncproxy_base_url = http://controller:6080/vnc_auto.html

Tables

Here’s a sample table:

OpenStack projects

Name

Role

Description

Nova

Compute

To implement services and associated libraries to provide massively scalable, on demand, self service access to compute resources, including bare metal, virtual machines, and containers.

Neutron

Networking

OpenStack Neutron is an SDN networking project focused on delivering networking-as-a-service (NaaS) in virtual compute environments.

Swift

Object store

Swift is a highly available, distributed, eventually consistent object/blob store. Organizations can use Swift to store lots of data efficiently, safely, and cheaply. It’s built for scale and optimized for durability, availability, and concurrency across the entire data set. Swift is ideal for storing unstructured data that can grow without bound.

Notices

Notices take these forms.

note

Note

A comment with additional information that explains a part of the text.

important

Important

Something you must be aware of before proceeding.

tip

Tip

An extra but helpful piece of practical advice.

caution

Caution

Helpful information that prevents the user from making mistakes.

seealso

See also

A reference to another piece of related information, like a related setting or upstream documentation

warning

Warning

Critical information about the risk of data loss or security issues.

Configuration addition and deprecation notices

New in version 9.0.0-Mitaka.

New in version 10.0.0-Newton.

Changed in version 10.0.0-Newton: Added support for new tags!

Changed in version 11.0.0-Ocata: Showing that multiple notices work!

Deprecated since version 11.0.0-Ocata: Use Notices instead.

Deprecated since version 12.0.0-Pike: A second deprecation notice