An open API service indexing awesome lists of open source software.

https://github.com/purestorage-openconnect/openstack-docs

Pure Storage OpenStack Deployment & Operations Guide
https://github.com/purestorage-openconnect/openstack-docs

Last synced: 8 months ago
JSON representation

Pure Storage OpenStack Deployment & Operations Guide

Awesome Lists containing this project

README

          

Pure Storage OpenStack Deployment & Operations Guide
==============================================

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

This repository contains documentation to aid operators and users of
OpenStack clouds powered by Pure Storage FlashArray.

The latest build of this documentation is live here:

[https://pure-storage-openstack-docs.readthedocs.io/en/latest/](https://pure-storage-openstack-docs.readthedocs.io/en/latest/)

Contributing
------------

We welcome contributions and requests for enhancement. If you find bugs in
the documentation, please file
an [issue](https://github.com/PureStorage-OpenConnect/openstack-docs/issues). You
may also do this from within the documentation webpage, using the bug links
provided on each page.

This documentation is written and built with Sphinx using
[reStructured Text](http://www.sphinx-doc.org/en/stable/rest.html) as the
markup language.

To build this guide, you will need
[tox](https://tox.readthedocs.io/en/latest/).

Install tox by running:

```
pip install tox
```

From inside the repository, build this guide with:

```
tox -e docs
```

It requires [PyEnchant installation](https://pyenchant.github.io/pyenchant/install.html#installing-the-enchant-c-library). On Ubuntu:

```
sudo apt install python3-enchant
```

A "build" folder is created with doctrees and html output.

If you're building this on macOS, it is possible you'll run into dependency
issues if you do not have Xcode Command Line utilities enabled. You can
enable it with:

```
xcode-select --install
```

Attributions
------------

The theme used by the builds of this documentation was [developed by the
OpenStack community](https://docs.openstack.org/openstackdocstheme/latest/).