Update CONTRIBUTING and HACKING

Update README.rst to not point to HACKING.rst, only CONTRIBUTING.rst.

Remove HACKING.rst because it is redundant in purpose, and incorrect
in content.

Update CONTRIBUTING.rst to point to the contributor docs on
docs.openstack.org and generally be a bit less generic than before.

Change-Id: Ib608b494e027091ae324793f275bad3b554e9710
Story: 2005190
Task: 29949
Task: 29950
This commit is contained in:
Chris Dent 2019-03-11 18:28:36 +00:00
parent 69b9659a45
commit b895b02c6d
3 changed files with 15 additions and 43 deletions

View File

@ -1,16 +1,22 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps in this page:
If you would like to contribute to the development of the Placement service and
have never developed for an offical OpenStack project before, you must follow
the steps in this page to perform required setup:
https://docs.openstack.org/infra/manual/developers.html
https://docs.openstack.org/infra/manual/developers.html
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
Once those steps have been completed, changes to OpenStack may be submitted for
review via the Gerrit tool, following the workflow documented at:
https://docs.openstack.org/infra/manual/developers.html#development-workflow
https://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
There is a growing suite of documentation for Placement contributors published
at:
Bugs should be filed on StoryBoard, not GitHub:
https://docs.openstack.org/placement/latest/contributor/index.html
Note that OpenStack does not use GitHub. Pull requests and issues submitted
there will not be seen.
Bugs should be filed on StoryBoard:
https://storyboard.openstack.org/#!/project/openstack/placement

View File

@ -1,31 +0,0 @@
======================
NOTE: WORK IN PROGRESS
======================
This document needs to be updated to remove nova-specific references, and to
include hacking rules as we determine they are needed.
Building Docs
-------------
Normal Sphinx docs can be built via the setuptools ``build_sphinx`` command. To
do this via ``tox``, simply run ``tox -e docs``,
which will cause a virtualenv with all of the needed dependencies to be
created and then inside of the virtualenv, the docs will be created and
put into doc/build/html.
Building a PDF of the Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you'd like a PDF of the documentation, you'll need LaTeX and ImageMagick
installed, and additionally some fonts. On Ubuntu systems, you can get what you
need with::
apt-get install texlive-full imagemagick
Then you can use the ``build_latex_pdf.sh`` script in tools/ to take care
of both the sphinx latex generation and the latex compilation. For example::
tools/build_latex_pdf.sh
The script must be run from the root of the Placement repository and it will
copy the output pdf to Placement.pdf in that directory.

View File

@ -53,9 +53,6 @@ Developers
For information on how to contribute to Placement, please see the contents of
CONTRIBUTING.rst.
Any new code must follow the development guidelines detailed in the HACKING.rst
file, and pass all tests.
Further developer focused documentation is available at:
- `Official Placement Documentation <https://docs.openstack.org/placement/>`__