The general guide to contributing to OpenStack.
7c1bbb5216
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 |
||
---|---|---|
doc | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
bindep.txt | ||
LICENSE | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
Team and repository tags
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.
- Free software: Apache license
- Documentation: https://docs.openstack.org/contributors
- Source: https://opendev.org/openstack/contributor-guide/
- Bugs: https://storyboard.openstack.org/#!/project/913
- Release Notes: https://docs.openstack.org/releasenotes/openstack-manuals/