openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
20,601 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
d175b76864
Go to file
Adam Spiers d175b76864 Fix per-project deprecation badges 
I2498f00a6c863d078a70289a655b0aa3958325ed changed the badge shown at
the top of documentation pages which describes the state of the
release of the documentation currently being viewed.  However the
unfortunately release-switcher dropdown it introduced into
deprecated_badge.tmpl had the side-effect of affecting the badge.html
which is dynamically included in project documentation by some
Javascript in theme/openstackdocs/layout.html within the
openstackdocstheme repository, and the new release switcher was only
designed to work with openstack-manuals, not with any other projects.

This broke the badge for all releases (www/$RELEASE/badge.html),
excluding www/latest/ which has a hard-coded badge.html.  This was
missed during testing because the dynamic inclusion mechanism is
hardcoded to retrieve the badge from https://docs.openstack.org rather
than any local repository.

For a quick fix, reintroduce the old badge template as

    www/templates/project_deprecated_badge.tmpl

and change all the per-project badges to use this.  Later we can
investigate the possibility of enhancing this per-project badge so
that it provides release-switching functionality like the badge
currently in openstack-manuals.

Change-Id: I53c4b35e31bcdda16ffd50f9a8a26c773c8d3574
2019-02-21 10:47:40 +00:00
doc Merge "Adding etcd clarification note" 2019-02-19 17:49:22 +00:00
playbooks/build-manuals-tox Add native zuulv3 set up 2017-10-09 22:07:27 +02:00
releasenotes/source Imported Translations from Zanata 2019-01-14 07:14:55 +00:00
tools Provide dropdown menu which allows switching doc release 2019-01-24 00:19:22 +00:00
www Fix per-project deprecation badges 2019-02-21 10:47:40 +00:00
.gitignore www-generator.py: cache expensive repo/project metadata to disk 2019-01-04 17:10:22 +00:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
.pydevproject [config-ref] Update api-paste.ini of manila 2017-04-13 19:38:07 +08:00
.zuul.yaml Add missing xindy bindep 2018-09-12 16:30:55 -06:00
bindep.txt Add missing xindy bindep 2018-09-12 16:30:55 -06:00
CONTRIBUTING.rst [contrib-guide] Updating url to doc-contrib-guide 2017-09-22 14:57:47 +00:00
doc-tools-check-languages.conf Arch-design cleanup 2018-11-30 21:09:30 -05:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
projects.txt Sync common files to ops and ha guides 2018-11-23 06:21:34 +01:00
README.rst Add release note in README 2018-07-17 22:14:41 +08:00
test-requirements.txt www-generator.py: cache expensive repo/project metadata to disk 2019-01-04 17:10:22 +00:00
tox.ini Update min tox version to 2.0 2018-11-02 06:44:12 +00: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:

  • Architecture Design Guide
  • Documentation Contributor Guide
  • High Availability Guide
  • Installation 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

Some pre-requisites are needed to build the guides. If you are using a Linux operating system you can generate a report of missing local requirements with the bindep command:

$ tox -e bindep

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

$ tox -e docs

You can also build a specific guide.

For example, to build OpenStack Virtual Machine Image Guide, use the following command:

$ tox -e build -- image-guide

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

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

To build a specific guide with a PDF file, add a -pdf option like:

$ tox -e build -- image-guide --pdf

The generated PDF file will be copied to the root directory of the generated HTML documentation.

PDF builds are accomplished using LaTeX as an intermediate format. Currently, you can generate a PDF file for a limited number of guides. The supported list is maintained in the tools/build-all-rst.sh file.

If you get the error message make: xelatex: No such file or directory, it means your local environment does not have LaTeX installed. Read Getting LaTeX and Install dependencies for building documentation for instructions.

Testing of changes and building of all manuals

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

If you like to run individual tests, run:

  • tox -e checkbuild - to actually build the manual; this also generates a directory publish-docs that contains the built files for inspection
  • tox -e checklang - to build translated manuals
  • tox -e linters - to run the niceness tests, for example, to see extra whitespaces
  • tox -e linkcheck - to run the tests for working remote URLs

The tox command uses the openstack-doc-tools package to run the 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

Release Notes

https://docs.openstack.org/releasenotes/openstack-manuals

Installing

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