openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
18,241 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
1986be3364
Go to file
zhangguoqing 1986be3364 Delete the presence of default flavors 
There are not any default flavors after the commit
"Remove flavor seeding from the base migration" which
removes default flavors from the database, that means
the new deploys will not have them(m1.tiny, m1.small,
m1.medium, m1.large, m1.xlarge).

Change-Id: Ifcdd6f1500a937de8dfd9d265bd5ee3406cb70e0
Closes-Bug: #1567009
2017-01-30 09:56:01 +10:00
doc Delete the presence of default flavors 2017-01-30 09:56:01 +10:00
releasenotes/source Releasenotes: Mention https 2017-01-27 13:57:31 +01:00
tools Add documentation for Manila MapRFS driver 2017-01-27 13:37:58 +00:00
www [www] Use https 2017-01-27 17:19:25 +01:00
.gitignore Add "*.swo" to ".gitignore" file 2016-08-09 06:18:46 +00:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
bindep.txt PDF generation support with --pdf option 2016-12-01 21:55:40 +00:00
CONTRIBUTING.rst Adds new CONTRIBUTING.txt and updates README.rst 2017-01-11 11:47:29 +00:00
doc-tools-check-languages.conf [i18n] build Indonesian Networking Guide 2017-01-27 22:22:55 +09:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
projects.txt [ha-guide] Changes after ha-guide is merged to manuals 2016-05-05 21:12:50 +05:30
README.rst Adds new CONTRIBUTING.txt and updates README.rst 2017-01-11 11:47:29 +00:00
test-requirements.txt Switch to current Sphinx 2017-01-13 16:36:45 +01:00
tox.ini Test that glossary is sorted 2016-11-14 16:43:19 +01:00

README.rst

Team and repository tags

image

OpenStack Manuals

This repository contains documentation for the OpenStack project.

For more details, see the OpenStack Documentation Contributor Guide.

It includes these manuals:

  • Administrator Guide
  • Architecture Design Guide
  • Command-Line Interface Reference
  • Configuration Reference
  • Documentation Contributor Guide
  • End User Guide
  • High Availability Guide
  • Installation Tutorials
  • Networking Guide
  • Operations Guide
  • Virtual Machine Image Guide

In addition to the guides, this repository contains:

  • docs.openstack.org contents: www

Building

Various manuals are in subdirectories of the doc/ directory.

Guides

All guides are in the RST format. You can use tox to prepare virtual environment and build all guides:

$ tox -e docs

You can also build a specific guide.

For example, to build OpenStack End User Guide, use the following command:

$ tox -e build -- user-guide

You can find the root of the generated HTML documentation at:

doc/user-guide/build/html/index.html

Testing of changes and building of the manual

Install the Python tox package and run tox from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

  • tox -e checkbuild - to actually build the manual
  • tox -e checklang - to build translated manuals
  • tox -e checkniceness - to run the niceness tests
  • tox -e linkcheck - to run the tests for working remote URLs

tox will use the openstack-doc-tools package for execution of these tests.

Generated files

Some documentation files are generated using tools. These files include a do not edit header and should not be modified by hand. Please see Generated files.

Bugs

Bugs should be filed on Launchpad, not GitHub:

https://bugs.launchpad.net/openstack-manuals

Installing

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.