The general guide to contributing to OpenStack.
Go to file
Hervé Beraud 7c1bbb5216 Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].
Removed specific doc requirements from test-requirements.txt.

The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file
to pull requirements [4].

This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.

This project could meet the conditions leading to the bug, and
uniformization can't hurt. These changes will reduce the likelihood to face
pip resolver incompatibilities by splitting requirements.

[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-

Change-Id: I75450f05993a5e1fbebe647ffaab440a9a63bf95
2021-01-05 14:50:24 +01:00
doc Add doc/requirements 2021-01-05 14:50:24 +01:00
.gitignore Add Apple OS X ".DS_Store" to ".gitignore" file 2018-08-10 09:27:48 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:29:51 +00:00
.zuul.yaml use promote job 2019-08-21 20:33:21 +02:00
bindep.txt Add minimal bindep file 2017-10-24 19:41:41 +02:00
LICENSE Initial commit of the Contributor Portal 2017-10-16 15:43:49 -07:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-05-06 01:09:18 +08:00
requirements.txt Add test-requirements.txt 2017-11-17 20:31:18 +01:00
setup.cfg [ussuri][goal] Drop python 2.7 support and testing 2020-02-05 19:52:39 +01:00
setup.py [ussuri][goal] Drop python 2.7 support and testing 2020-02-05 19:52:39 +01:00
test-requirements.txt Add doc/requirements 2021-01-05 14:50:24 +01:00
tox.ini Add doc/requirements 2021-01-05 14:50:24 +01:00

Team and repository tags

image

The OpenStack Contributor Guide

The Contributor Guide for the OpenStack project.

To build the guide, execute the following command:

$ tox -e docs

After running tox -e docs, the guide will be available for viewing in HTML format in the doc/build/ directory.